Skip to content

Commit 97a521d

Browse files
committed
fix: remove duplicate commit message format section and update TOC
1 parent 68b589b commit 97a521d

File tree

1 file changed

+15
-28
lines changed

1 file changed

+15
-28
lines changed

booster/.github/CONTRIBUTING.md

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@ contribution.
99
- [Initial Setup](#initial-setup)
1010
- [Contributing](#contributing)
1111
- [Branch Naming](#branch-naming)
12+
- [Commit Message Format](#commit-message-format)
1213
- [Developer Tooling](#developer-tooling)
1314
- [Environment Variables](#environment-variables)
1415
- [Hook Footers](#hook-footers)
15-
- [Commit Messages](#commit-messages)
16+
- [Configuration Reference](#configuration-reference)
17+
- [Common Workflow Examples](#common-workflow-examples)
18+
- [Performance Monitoring](#performance-monitoring)
19+
- [Troubleshooting](#troubleshooting)
1620
- [Tools We Use](#tools-we-use)
1721
- [Required Visual Studio Code Extensions](#required-visual-studio-code-extensions)
1822
- [Required PHPStorm Extensions](#required-phpstorm-extensions)
@@ -61,23 +65,12 @@ Examples:
6165

6266
If the ticket pattern is enabled in config and you use a ticket prefix, it must include the number (e.g. `PRJ-123-...`).
6367

64-
### Commits and commit messages
65-
66-
Commit Size: Aim for small, focused commits that address a single issue or feature
67-
Commit Messages: Follow the Conventional Commits specification
68-
69-
We use Conventional Commits to maintain a clear and informative commit history. This helps us automate changelog
70-
generation, versioning, and other project
71-
management tasks.
72-
73-
### Commit Messages
68+
### Commit Message Format
7469

7570
Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for clear and consistent commit messages.
7671

7772
Each commit message should adhere to the following format:
7873

79-
#### Format
80-
8174
```
8275
<type>[optional scope]: <description>
8376
@@ -86,20 +79,14 @@ Each commit message should adhere to the following format:
8679
[optional footer(s)]
8780
```
8881

89-
- type: The type of change (e.g., feat, fix, chore, docs, etc.).
90-
- scope (optional): The scope of the change (e.g., the component or module affected).
91-
- description: A brief description of the change.
92-
- body (optional): A more detailed explanation of the change, if necessary.
93-
- footer(s) (optional): Additional information like breaking changes or issue references (e.g., "BREAKING CHANGE: ..."
94-
or "Fixes #123").
95-
- **type**: The type of change (e.g., feat, fix, chore, docs).
96-
- **scope** (optional): The area of the codebase affected.
97-
- **description**: A brief summary of the change.
98-
- **body** (optional): Detailed explanation, if needed.
99-
- **footer(s)** (optional): Additional info like breaking changes or issue references.
100-
101-
#### Examples
82+
Where:
83+
- **type**: The type of change (e.g., feat, fix, chore, docs)
84+
- **scope** (optional): The area of the codebase affected
85+
- **description**: A brief summary of the change
86+
- **body** (optional): Detailed explanation, if needed
87+
- **footer(s)** (optional): Additional info like breaking changes or issue references
10288

89+
Examples:
10390
- `feat: add user authentication`
10491
- `fix(auth): correct password validation error`
10592
- `chore: update dependencies`
@@ -178,7 +165,7 @@ All git hooks now include built-in performance monitoring:
178165
- **Individual tool timing**: Each tool shows execution time (e.g., "PHPStan completed successfully (2.3s)")
179166
- **Total execution time**: Hooks display total time taken (e.g., "All pre-commit checks passed! (Total time: 8.7s)")
180167
- **Failed tool timing**: Even failed tools show how long they ran before failing
181-
- **Performance insights**: Use `PRECOMMIT_VERBOSE=1` to see detailed output and identify slow tools
168+
- **Performance insights**: Use `GIT_HOOKS_VERBOSE=1` to see detailed output and identify slow tools
182169

183170
### Troubleshooting
184171

@@ -188,7 +175,7 @@ All git hooks now include built-in performance monitoring:
188175
| Missing footer | Ensure branch has valid ticket segment & config has prefixes. |
189176
| Slow pre-commit | Use `SKIP_PRECOMMIT=1`, or tool-specific skips (e.g., `SKIP_PHPSTAN=1 SKIP_PSALM=1`). Check performance timing to identify slow tools. |
190177
| Emergency commit needed | Use `SKIP_PRECOMMIT=1` + `SKIP_COMMITMSG=1` for complete bypass. |
191-
| Performance analysis | Enable `PRECOMMIT_VERBOSE=1` to see detailed tool execution times and identify bottlenecks. |
178+
| Performance analysis | Enable `GIT_HOOKS_VERBOSE=1` to see detailed tool execution times and identify bottlenecks. |
192179

193180
## Tools We Use
194181

0 commit comments

Comments
 (0)