From 003d8789d4016c4f4c993db17d2b07a9c01d5056 Mon Sep 17 00:00:00 2001 From: Kyle Sexton <153232337+kyle-sexton@users.noreply.github.com> Date: Thu, 27 Aug 2026 01:18:35 -0400 Subject: [PATCH] docs(contributing): qualify the branch-naming rule as a convention The org's branch-naming grammar lives in standards' conventions/engineering/naming.md, which calls the pattern deterministic and says a repo *may* gate it with a commit hook. None does: no branch-name check exists in this repository, in ci-workflows, or in standards, and the org ruleset does not constrain head-branch names. Step 1 stated it as a bare imperative anyway, while steps 4 and 5 already qualify what they claim, and the rule was underivable from primary sources because nothing here cited the convention that defines it. Closes #99 Co-Authored-By: Claude Fable 5 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2a52f6..d326074 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ A specific repository may override this org-wide default with its own `CONTRIBUT ## Workflow -1. Branch from the default branch using `/` (for example, `feat/add-widget`). +1. Branch from the default branch, naming it `/` (for example, `feat/add-widget`) per the org's [branch-naming convention](https://github.com/melodic-software/standards/blob/main/conventions/engineering/naming.md#branch-names-type-prefix-then-a-behavior-naming-slug). A repository may gate the pattern locally, but no check enforces it by default, so treat it as a convention rather than a requirement. 2. Make your change, with tests where applicable. 3. Ensure the project builds and its checks pass locally. 4. Open a pull request, fill out the template, and link the related issue. Title it using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) with one of the standard types — `[optional scope]: `, for example `feat(api): add pagination`. The title becomes the squash-merge commit subject on the default branch. Where the repository enforces this, a `pr-title` check reports on your pull request and must pass before merge.