File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff 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.
29382 . ** Implement** your change in ` src/ ` . Match existing formatting and naming.
30393 . ** Build** locally: ` npm run build ` (must pass with no TypeScript errors).
31404 . ** Document** user-visible behavior in ` README.md ` and, if structural, in ` docs/PROJECT_FLOW.md ` .
Original file line number Diff line number Diff 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.
29382 . ** Implement** your change in ` src/ ` . Match existing formatting and naming.
30393 . ** Build** locally: ` npm run build ` (must pass with no TypeScript errors).
31404 . ** Document** user-visible behavior in ` README.md ` and, if structural, in ` docs/PROJECT_FLOW.md ` .
You can’t perform that action at this time.
0 commit comments