docs(contributing): document commit and branch CI rules#41
Open
ZackStr wants to merge 1 commit into
Open
Conversation
Surface the regexes that .github/workflows/pr-compliance.yml enforces on every PR — Conventional Commits for commit messages and the branch-name pattern — so contributors don't get rejected by CI before they know the rules exist. Hit during PR itential#40, where the doc said nothing and the CI error pointed back at this file as the source of truth. - Replace the bullet list of branch prefixes with the literal CI regex, a field-by-field rule table, and per-type meanings (adds `refactor/`, which CI accepts but the doc had omitted). - Add a new "Commit Message Format" subsection: literal regex from CI, allowed types, scope, 72-char description limit, the no-merge-commits rule, and examples. - Call out the type-list mismatch between branches (`feature/`) and commits (`feat:`) — easy footgun. - Cross-link from step 3 of the Fork and Pull Model to the new section so readers see the rule before they start writing commits. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
@wcollins FYI |
Contributor
|
Acknowledged - Evaluating against the onboarding workflows before merging. |
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
3 participants
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
Surface the regexes that
.github/workflows/pr-compliance.ymlenforces on every PR — Conventional Commits for commit messages and the branch-name pattern — so contributors don't get blocked by CI before they know the rules exist.Hit during #40: my commit was rejected for
Default to vertical canvas orientation(nodocs:prefix). The CI error pointed at CONTRIBUTING.md as the source of truth, but CONTRIBUTING.md said nothing about commit format.Changes
^(feature|fix|refactor|docs|chore)/[a-z][a-z0-9-]*$, a field-by-field rule table, and per-type meanings. Addsrefactor/to the documented list (CI accepts it; doc had omitted it).^(feat|fix|docs|style|refactor|test|chore|perf)(\(.+\))?: .{1,72}regex, allowed types, optional scope, 72-char description limit, the no-merge-commits rule, and examples.feature/(full word), commits usefeat:(Conventional Commits short form). Easy footgun.Testing
docs/contributing-ci-rulesmatches the documented regexdocs(contributing): document commit and branch CI rulesmatches the documented regex (54 chars)Branch Naming,Commit Messages) are expected to pass — this PR self-validates the documented rules🤖 Generated with Claude Code