chore(pm): document decision-record PRs land as docs (PR-title vs commit-type)#422
Merged
Merged
Conversation
…mit-type) Reconcile the commit/branch type vocabulary (which includes decision) with the PR-title pattern (standard CC set only) by documenting the deliberate mismatch: under squash-merge the PR title becomes the landed commit, so decision-record PRs are titled docs(<scope>) for tooling-safe history. Documented in the pr and branch-name schema entries + the capability README; also fixes a self- contradictory branch-vs-PR sentence. No pattern/validation change. Closes #236. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Owner
Author
|
Reviewer agent (local, reviewer): APPROVED
Notes (non-blocking):
|
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.
What
Direction B for #236: reconcile the commit/branch type vocabulary (which includes
decision) with the PR-title pattern (standard CC set only) by documenting the deliberate mismatch — no pattern change.Under squash-merge the PR title becomes the landed commit, so decision-record PRs are deliberately titled
docs(<scope>): ...to keepgit logon standard Conventional-Commits types (changelog/tooling-safe). Adecision/<n>-...branch stays permitted; its PR lands asdocs(...).Changes (documentation only)
titles.yamlprentry — description expanded + good/bad examples (docs(decisions): ...good;decision(pm): ...bad).git-conventions.yamlbranch-name entry — branch-vs-PR-title asymmetry note; fixes a pre-existing self-contradictory sentence (said a PR takes thedecisiontype — corrected to branch).Doc impact
This PR is the doc change. No regex/validation/severity/schema_version change.
Surface / version
Non-surface — documentation inside schema
description/examplesfields; patterns unchanged. No.pkit/VERSIONbump, no migration (confirmed).Follow-up (flagged, not in this PR)
COR-008 (core) lists
decisionas a commit type without noting the squash-merge PR-title=docs interaction; a one-line clarifying note there would close the loop — left as a follow-up (core record, out of scope here).Verification
pkit schemas validate-> all pass;pkit migrations check-diff-> no triggers;pkit refs validate-> no new findings.Closes #236.