docs: add a branch-management policy#97
Merged
Merged
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8cc6bfcab7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
The guide governed commits and pull request titles but said nothing about the branch that carries them. This adds a Branches section before Commit messages, so the guide reads in workflow order: branch, commit, request. It fixes the branch as the disposable workspace of one pull request, cut from a fresh origin/main and spent on merge. Branch names take an <author>/<description> form, not <type>/. A branch gathers commits of several types, so a single type prefix would name one and hide the rest, the reason a multi-intention pull request title carries no type either. The owner is the one thing the commits do not already record, so claude/ and dependabot/ become the rule, not an exception. Co-Authored-By: Claude Opus 4.8 <[email protected]> Claude-Session: https://claude.ai/code/session_01MAHFZWHiPnWKLfA6BiGLDK
8cc6bfc to
5585183
Compare
Owner
Author
|
@codex Ok for the fix ? |
|
Yes — the fix looks OK for both review comments. Review of requested fixes
No new changes were needed from me, so I did not create an additional commit or PR. Checks run
|
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
Add a
Branchessection toCONTRIBUTING.md, defining how a branch is named, created, scoped, and retired. It completes the workflow the guide already documents for commits and pull request titles, so the guide now reads in order: branch → commit → request.Type of change
Changes
## Branchessection toCONTRIBUTING.md, placed before## Commit messagesso the guide reads in workflow order (branch → commit → request).<author>/<short-description>branch names, where<author>is the owner's GitHub handle (sylvain/…,claude/…,dependabot/…). The change type stays on the commits, where the hook and CI enforce it; a branch carries no type, soclaude/anddependabot/are the rule, not an exception.origin/main, never revived once merged or closed.git log/git diffagainstorigin/main).Testing
Documentation-only change; no source, build, or test target is affected, so the
dotnetcommands below were not run.dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)The commit message was validated against the repository's own linter,
tools/commit-lint/lint-commit-message.sh, in both local and--cimodes.Documentation
This PR is the documentation change (
CONTRIBUTING.md, a repository-governance document). None of the boxes below apply: no public API / error documentation,README, ordoc/update is involved, and no French translation is needed —CONTRIBUTING.mdis English-canonical with no French counterpart, and no user-facing library behavior changed.doc/updateddoc/README.fr.md) updated if user-facing behavior changedRelated issues
None — the policy was proposed and refined directly; there is no tracking issue.
🤖 Generated with Claude Code
https://claude.ai/code/session_01MAHFZWHiPnWKLfA6BiGLDK
Generated by Claude Code