docs: contributing describes the protection that now exists - #28
Merged
Conversation
`main` is protected on all sixteen public repos: pull requests required, force pushes and deletions refused, linear history, and the rules applied to admins. The single required status check is the merge gate. CONTRIBUTING already said every CI job is required and none is advisory. That was the intent and not the state — ten of the sixteen repos had no branch protection at all, and the discipline was held up by a local git hook on one machine. The sentence is now true. Documents the two properties a contributor cannot infer: that the gate treats a skipped dependency as a failure, because GitHub scores skipped as passing and a rollup without `always()` reports green precisely when something broke; and that the gate refuses to pass while any job in its workflow sits outside its `needs:` list, so adding a job to CI makes it blocking with no settings edit to remember.
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
1 participant
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.
CONTRIBUTING already said "Every CI job is required; none is advisory." That was the intent, not the state — ten of the sixteen public repos had no branch protection at all, and the discipline was held up by a local git hook on one machine. The sentence is now true.
mainis protected on all sixteen: pull requests required, force pushes and deletions refused, linear history, and the rules applied to admins. The single required status check ismerge gate(plusmerge gate (security)where a separate security workflow exists).Documents the two properties a contributor cannot infer from the name:
skippedas a failure. GitHub scores a skipped check as passing for branch protection, so a rollup withoutif: always()reports green precisely when something broke.needs:list — so adding a job to CI makes it blocking automatically, with no branch-protection edit to remember.This PR is also the end-to-end proof that the new protection permits a normal merge: it is the first PR opened after
enforce_admins,strict, linear history and the required gate went on.