Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<type>/<name>` 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
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ follows the version pins recorded in [VERSION](VERSION) (`VORTEX_VERSION`,

### Added

- **Branch naming types.** Branches are named `<type>/<name>` 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/<name>.json` names a machine (`tinygpu`, `gtx1080`, `v100`, `a100`, `h100`, `rtx5080`) that every flow
builds through `configure --profile=<name>` or `blackbox.sh --profile=<name>`; 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
Expand Down
26 changes: 25 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
`<type>/<name>`, 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/`.
- `<name>` 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 <local>:<type>/<name>`.
- The same names apply to branches pushed to this repository.
- Maintainers also keep two long-lived types: `release/<version>` for
a release line and `archive/<name>` 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
Expand Down
Loading