Skip to content

docs(contributing): qualify the branch-naming rule as a convention #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kyle-sexton merged 1 commit into from
Aug 27, 2026
Merged

docs(contributing): qualify the branch-naming rule as a convention #104

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<type>/<description>` (for example, `feat/add-widget`).
1. Branch from the default branch, naming it `<type>/<short-description>` (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 — `<type>[optional scope]: <description>`, 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.
Expand Down
Loading