docs: adopt the org's <type>: summary commit convention - #816
Merged
Conversation
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.
Summary
This repo documented a commit style of its own —
Short title — what & why, with branch prefixesfix/ refactor/ docs/ cleanup/ feat/ test/— while every other OpusProjects repo titles commits and PRs<type>: short imperative summary. Aligning the docs makes one convention hold across the org, and matches thebuild(deps):prefix Dependabot now writes here (#815).Changes
CONTRIBUTING.md: commit example and the "Commit messages" section use<type>: short imperative summary; the prefix list becomes the org type list, covering both branch names and titlesCLAUDE.md: same commit example, plus the type list alongside the other workflow notesThe type list gains
perf,buildandchore, and dropscleanup(refactororchorecovers it). Workflow itself is unchanged: one logical change per PR, squash-merged, never straight tomain.Existing history keeps its titles — this only governs commits from here on.