docs: add branch naming convention to AGENTS.md and CONTRIBUTING.md#2678
Merged
Merged
Conversation
- AGENTS.md: branch naming as a requirement for AI coding agents - CONTRIBUTING.md: branch naming as a recommendation for human contributors - Convention: <type>/<number>-<short-slug> where number is issue or PR number Closes github#2677
Contributor
There was a problem hiding this comment.
Pull request overview
Documents a consistent branch naming convention across the project’s contributor guidance, making branch cleanup and traceability easier in a squash-merge workflow.
Changes:
- Updates the “Submitting a pull request” checklist in
CONTRIBUTING.mdto reference the new branch naming convention. - Adds a “Branch naming” section to
CONTRIBUTING.md(recommendation for human contributors). - Adds a “Branch Naming Convention” section to
AGENTS.md(requirement for AI agents).
Show a summary per file
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds a recommended branch naming convention section and links to it from the PR submission checklist. |
| AGENTS.md | Adds a required branch naming convention section for deterministic agent compliance. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 0
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.
Summary
Adds a branch naming convention to both
AGENTS.mdandCONTRIBUTING.md.Convention
Where
<number>is either an issue number or a PR number — whichever is created first.feat/feat/2342-workflow-cli-alignmentfix/fix/2653-paths-only-validationdocs/docs/2677-branch-naming-conventioncommunity/community/2492-add-mde-extensionchore/chore/2366-editorconfigApproach
AGENTS.md: Branch naming as a requirement — AI agents comply deterministically when instructedCONTRIBUTING.md: Branch naming as a recommendation — human contributors get guidance without being blocked. The note about using PR numbers accommodates contributors who start with a PR rather than an issue.Why
The project uses squash merges, so
git branch --mergeddoesn't detect merged branches. Including an issue/PR number in every branch name makes cleanup and traceability straightforward.Self-referential
This PR's own branch (
docs/2677-branch-naming-convention) follows the documented convention.Closes #2677