Skip to content

Document the branch naming types in CONTRIBUTING.md - #477

Merged
tinebp merged 1 commit into
masterfrom
docs/branch-types
Nov 15, 2026
Merged

tinebp merged 1 commit into
masterfrom
docs/branch-types

Conversation

@tinebp

@tinebp tinebp commented Nov 15, 2026

Copy link
Copy Markdown
Collaborator

Writes down the branch naming scheme in CONTRIBUTING.md ("Submitting changes", step 1).

Branches are named <type>/<name>, with one of six types:

type the branch
feature/ adds a capability: hardware, simulator, runtime or API
fix/ corrects wrong behavior: a wrong result, hang, crash or regression
perf/ improves cycles, Fmax or area without changing results or capabilities
refactor/ restructures code without changing results, capabilities, cycles or area
ci/ changes CI, gates, baselines, build scripts or tests only
docs/ changes documentation only
  • A branch that fits several types takes the first in table order. For example, a fix with its regression test is fix/.
  • <name> is two to five lowercase, hyphenated words, with no further /.
  • Maintainers also keep release/<version> and archive/<name>.
  • master and gh-pages keep their names.
  • The rule applies to fork branches and to branches pushed to this repository.

AGENTS.md's documentation map and the CHANGELOG (Unreleased, Added) point to the new section. Documentation only; no build or test impact.

🤖 Generated with Claude Code

Branches follow a <type>/<name> scheme that was never written down, so
contributors had to guess the prefixes from the remote. Define a finite
list of six types, each by what the change does (feature, fix, perf,
refactor, ci, docs), the order to pick from when a branch fits several,
the shape of <name>, and the two long-lived maintainer types (release,
archive). The rule covers branches pushed to this repository as well as
fork branches. AGENTS.md's documentation map and the changelog point to
it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tinebp
tinebp merged commit 26d2bc4 into master Nov 15, 2026
0 of 4 checks passed
@tinebp
tinebp deleted the docs/branch-types branch November 15, 2026 05:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant