Skip to content

Commit 028053d

Browse files
docs: document features/* and bugs/* branch naming in CONTRIBUTING
Made-with: Cursor
1 parent d4786fa commit 028053d

2 files changed

Lines changed: 20 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,16 @@ Describe the use case and whether it can live in userland (middleware) vs core.
2525

2626
### Pull requests
2727

28-
1. **Fork** the repository and create a branch from `main` (for example `fix/timeout-signal` or `feat/cache-key`).
28+
#### Branch naming
29+
30+
Use **one branch per concern**: a single feature **or** a single bug fix, not unrelated changes in the same branch.
31+
32+
- **Features:** `features/<short-description>` — for example `features/add-retry`, `features/cache-key-override`.
33+
- **Bug fixes:** `bugs/<short-description>` — for example `bugs/timeout-signal`, `bugs/cache-key-collision`.
34+
35+
Use **kebab-case** after the prefix. Keep the slug short but specific enough that reviewers can tell what the branch is for.
36+
37+
1. **Fork** the repository and create a branch from `main` following the [branch naming](#branch-naming) rules above.
2938
2. **Implement** your change in `src/`. Match existing formatting and naming.
3039
3. **Build** locally: `npm run build` (must pass with no TypeScript errors).
3140
4. **Document** user-visible behavior in `README.md` and, if structural, in `docs/PROJECT_FLOW.md`.

openFetch/CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,16 @@ Describe the use case and whether it can live in userland (middleware) vs core.
2525

2626
### Pull requests
2727

28-
1. **Fork** the repository and create a branch from `main` (for example `fix/timeout-signal` or `feat/cache-key`).
28+
#### Branch naming
29+
30+
Use **one branch per concern**: a single feature **or** a single bug fix, not unrelated changes in the same branch.
31+
32+
- **Features:** `features/<short-description>` — for example `features/add-retry`, `features/cache-key-override`.
33+
- **Bug fixes:** `bugs/<short-description>` — for example `bugs/timeout-signal`, `bugs/cache-key-collision`.
34+
35+
Use **kebab-case** after the prefix. Keep the slug short but specific enough that reviewers can tell what the branch is for.
36+
37+
1. **Fork** the repository and create a branch from `main` following the [branch naming](#branch-naming) rules above.
2938
2. **Implement** your change in `src/`. Match existing formatting and naming.
3039
3. **Build** locally: `npm run build` (must pass with no TypeScript errors).
3140
4. **Document** user-visible behavior in `README.md` and, if structural, in `docs/PROJECT_FLOW.md`.

0 commit comments

Comments
 (0)