[DOCS] Simplify PR title syntax toward Conventional Commits#6
Draft
John McCall (lowlydba) wants to merge 5 commits into
Draft
[DOCS] Simplify PR title syntax toward Conventional Commits#6John McCall (lowlydba) wants to merge 5 commits into
John McCall (lowlydba) wants to merge 5 commits into
Conversation
Move PR title format from bracket-style [TYPE]/[TYPE](scope)/[BREAKING][TYPE] to Conventional Commits syntax: type: description, type(scope): description, and type(scope)!: description for breaking changes. Map existing type vocabulary to Conventional Commits equivalents (fix, feat, docs, refactor, test, chore, perf, security, investigation), merging FEATURE/ENHANCEMENT into feat. Related to OvertureMaps/operating-procedures#95. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Investigation/spike work shouldn't typically result in PRs, so drop it from the Conventional Commits type table. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
security isn't a standard Conventional Commits type. Security fixes now map to fix, with (security) as the suggested scope for discoverability. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Keep the old bracket-style type names visible alongside their new Conventional Commits equivalents for easier migration reference. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
The old-to-new type mapping is documented in the PR description instead; keep the doc's table focused on the current type vocabulary. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
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.
What
Updates
docs/pull-request-checks.mdto move the PR title format from our bracket-style syntax ([TYPE],[TYPE](scope),[BREAKING][TYPE]) to Conventional Commits syntax:type: description,type(scope): description, andtype(scope)!: descriptionfor breaking changes.Existing type vocabulary mapped to Conventional Commits equivalents:
BUGfixFEATUREfeatENHANCEMENTfeatDOCSdocsREFACTORrefactorTESTtestCHOREchorePERFORMANCEperfSECURITYfix(use(security)scope, e.g.fix(security): ...)INVESTIGATIONFEATUREandENHANCEMENTboth map tofeatsince Conventional Commits doesn't distinguish new functionality from improvements.SECURITYfolds intofixsincesecurityisn't a standard Conventional Commits type — the(security)scope keeps it discoverable.10distinct types to7Related to OvertureMaps/operating-procedures#95.
Important: follow-up required
This doc change alone does not enforce the new syntax. The actual PR title validation logic (the regex/check that runs in CI) lives in the OvertureMaps/workflows repo and will need a follow-up PR there to accept and enforce the new Conventional Commits format before this becomes the real, enforced standard.