Repository navigation
Add a contributing guide that explains signed commits - #231
Merged
Merged
Conversation
The develop and main rulesets now reject unsigned commits, so an outside contributor can open a pull request that can never be merged without knowing why. The guide states the signing requirement up front, alongside the setup, checks and workflow that were previously only in AGENTS.md. It is kept out of the release ZIP and the WordPress.org build, as it is only useful to people working on the repository.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
developandmainrulesets now require signed commits, which means a pull request containing an unsigned commit can't be merged until its author re-signs and force-pushes. The plugin standards baseline asks for this to be stated inCONTRIBUTING.md, but this repository didn't have one, so an outside contributor would only discover the rule when the merge button stayed grey.This adds a contributing guide, modelled on the one in BuddyPress Hidden Profiles and adapted to this repository's tooling (Composer scripts, unit and integration suites, a globally installed
wp-env). The signing requirement sits in the pull request section with a link to GitHub's guide. The file is excluded from the release ZIP and the WordPress.org build through.distignoreand.gitattributes, and the readme's Contributing section now points to it.The rest of the baseline gaps in the ticket (merge methods, auto-merge, ruleset merge restrictions, private vulnerability reporting, secret scanning with push protection, and the label renames) were applied directly to the repository settings, so they aren't part of this diff.
Part of VIPPLUG-170.