Skip to content

Commit ccf91d4

Browse files
author
RandomCrocodile
committed
docs: update commit convention to match branch naming — full words, no scopes
1 parent 093102d commit ccf91d4

1 file changed

Lines changed: 33 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -129,20 +129,43 @@ dotnet test Tests/Confuser.CLI.Test/Confuser.CLI.Test.csproj -c Release --collec
129129

130130
Every PR receives an automatic coverage comment showing per-assembly line and branch coverage. The full HTML drill-down report is downloadable as the `coverage-report` artifact from the test workflow.
131131

132-
## Commit Conventions
133-
134-
We use [Conventional Commits](https://www.conventionalcommits.org/):
132+
## Commit Format
135133

136134
```
137-
feat(scope): add new feature
138-
fix(scope): fix a bug
139-
test(scope): add or update tests
140-
refactor(scope): code change that doesn't fix a bug or add a feature
141-
chore(scope): build, CI, dependency updates
142-
docs(scope): documentation changes
135+
<type>: <short description>
136+
137+
[optional body — what changed and why]
143138
```
144139

145-
Always reference the issue number: `fix(renamer): handle FnPtr types (#6)`
140+
**Types** — full words, matching branch naming:
141+
142+
| Type | When to use |
143+
|------|-------------|
144+
| `feature` | New feature or capability added |
145+
| `fix` | Bug fix |
146+
| `test` | Adding or updating tests |
147+
| `refactor` | Code change that neither fixes a bug nor adds a feature |
148+
| `chore` | Build config, dependencies, tooling, project setup |
149+
| `docs` | Documentation only changes |
150+
| `hotfix` | Urgent fix applied directly to main |
151+
| `experiment` | Exploratory or throwaway work |
152+
153+
**Rules:**
154+
- Full words only — no abbreviations (`feature` not `feat`)
155+
- No parenthesized scopes — the description should be clear enough
156+
- Reference issue number at end when applicable: `(#42)`
157+
- Lowercase first word after colon
158+
159+
**Examples:**
160+
161+
```
162+
feature: add symbol server support (#54)
163+
fix: handle locked file exception on folder scan (#42)
164+
test: add cross-framework integration tests
165+
chore: update dependencies
166+
docs: add plugin development guide
167+
refactor: extract base repository to reduce duplication
168+
```
146169

147170
## Pull Request Process
148171

0 commit comments

Comments
 (0)