Skip to content

Commit ae02988

Browse files
committed
refactor: update CONTRIBUTING.md to clarify branch naming enforcement and remove scripts section
1 parent e0f768f commit ae02988

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

booster/.github/CONTRIBUTING.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ contribution.
1010
- [Contributing](#contributing)
1111
- [Branch Naming](#branch-naming)
1212
- [Developer Tooling](#developer-tooling)
13-
- [Scripts](#scripts)
1413
- [Environment Variables](#environment-variables)
1514
- [Hook Footers](#hook-footers)
1615
- [Commit Messages](#commit-messages)
@@ -43,7 +42,7 @@ clean and readable.
4342

4443
### Branch Naming
4544

46-
Enforced automatically via `validate-branch-name` (see `validate-branch-name.config.cjs`).
45+
Enforced automatically via the `commit-msg` git hook (see `validate-branch-name.config.cjs`).
4746

4847
Format:
4948
```
@@ -115,13 +114,6 @@ Git hooks (managed via Husky) enforce naming, formatting and static analysis:
115114
* `pre-commit`: PHP lint, Rector, ECS, Deptrac, PHPStan, Psalm (auto-fix where possible)
116115
* `pre-push`: deptrac, tests, API spec & HTML doc generation (conditional)
117116

118-
### Scripts
119-
120-
| Script | Purpose |
121-
|--------|---------|
122-
| `pnpm validate:branch` | Validate current (or specified) branch name. |
123-
| `pnpm hooks:test` | Self-test `commit-msg` hook (footer behavior). |
124-
125117
### Environment Variables
126118

127119
| Variable | Effect |
@@ -151,7 +143,7 @@ Footer label is configurable via `commitFooterLabel` in `validate-branch-name.co
151143

152144
| Issue | Resolution |
153145
|-------|------------|
154-
| Branch rejected | Run `pnpm validate:branch` and adjust name. |
146+
| Branch rejected | Check branch name format against `validate-branch-name.config.cjs` rules. |
155147
| Missing footer | Ensure branch has valid ticket segment & config has prefixes. |
156148
| Slow pre-commit | Temporarily export `BYPASS_PHP_ANALYSIS=1` (avoid committing with unchecked code routinely). |
157149

0 commit comments

Comments
 (0)