diff --git a/AGENTS.md b/AGENTS.md index 3d4391f64f..da903b39b7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -31,7 +31,7 @@ This is the canonical entry point for **both human contributors and AI coding ag - [docs/synthesis_analysis.md](docs/synthesis_analysis.md) — synthesis/PPA analysis ### Process -- [CONTRIBUTING.md](CONTRIBUTING.md) — public fork/PR contribution flow +- [CONTRIBUTING.md](CONTRIBUTING.md) — public fork/PR contribution flow and the `/` branch naming types - [docs/bug_fixes.md](docs/bug_fixes.md) — bug-fix discipline (root-cause vs patch) - [docs/review/code-review-policy.md](docs/review/code-review-policy.md) — change-impact classes (R0-R3), review obligations and waivers - [docs/continuous_integration.md](docs/continuous_integration.md) — CI pipeline diff --git a/CHANGELOG.md b/CHANGELOG.md index 6049d34e5b..57c58a52cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ follows the version pins recorded in [VERSION](VERSION) (`VORTEX_VERSION`, ### Added +- **Branch naming types.** Branches are named `/` with one of six types (`feature/`, `fix/`, `perf/`, `refactor/`, + `ci/`, `docs/`), plus the maintainers' `release/` and `archive/`. See [CONTRIBUTING.md](CONTRIBUTING.md#submitting-changes). - **Hardware profiles.** `profiles/.json` names a machine (`tinygpu`, `gtx1080`, `v100`, `a100`, `h100`, `rtx5080`) that every flow builds through `configure --profile=` or `blackbox.sh --profile=`; explicit `CONFIGS` win over the profile. The GPU profiles are 64-bit machines with VM, atomics, TFU, shared memory and the tensor, DXA, ray-tracing and graphics units of diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1101e7a855..e002e1ca7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,31 @@ correctness issues, attach both the failing run and a known-good run External contributions go through GitHub pull requests against `master`: -1. Fork the repo and branch from `master`. +1. Fork the repo and branch from `master`. Name the branch + `/`, with one of the types below: + + | type | the branch | example | + |---|---|---| + | `feature/` | adds a capability: hardware, simulator, runtime or API | `feature/mlp-phase3` | + | `fix/` | corrects wrong behavior: a wrong result, hang, crash or regression | `fix/cta-dispatch-relaunch` | + | `perf/` | improves cycles, Fmax or area without changing results or capabilities | `perf/sgemv-issue-order` | + | `refactor/` | restructures code without changing results, capabilities, cycles or area | `refactor/out-buf-encoding` | + | `ci/` | changes CI, gates, baselines, build scripts or tests only | `ci/beacon-merge-base` | + | `docs/` | changes documentation only | `docs/fpga-setup-u55c` | + + - When a branch fits more than one type, use the first that applies in + the table's order: a fix that ships with its regression test is + `fix/`, while a test added on its own is `ci/`. + - `` says what changes in two to five words: lowercase letters, + digits and hyphens, with no further `/`. Leave out names, dates and + issue numbers. + - Bare names such as `vk-parity` and other types are not used. If your + local branch is named differently, push it under the right name with + `git push origin :/`. + - The same names apply to branches pushed to this repository. + - Maintainers also keep two long-lived types: `release/` for + a release line and `archive/` for retired work kept for + reference. `master` and `gh-pages` keep their names. 2. Build out-of-tree and run the regression suite for the area you touched before submitting. See [docs/testing.md](docs/testing.md) for the full test catalog and