Skip to content

Commit 5a86317

Browse files
author
Ivor Caldwell
committed
build: simplify set of types for commit linting
1 parent b2784a1 commit 5a86317

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

.commitlintrc.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
extends:
22
- '@commitlint/config-conventional'
3+
rules:
4+
type-enum: [2, 'always', [
5+
'build',
6+
'docs',
7+
'feat',
8+
'fix',
9+
'perf',
10+
'refactor',
11+
'revert',
12+
'test'
13+
]]

CONTRIBUTING.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -218,16 +218,13 @@ The commit message should be structured as follows:
218218

219219
| Type | Description | SemVer Impact |
220220
|------|-------------|---------------|
221-
| `build` | Changes that affect the build system or external dependencies | None (*unless functionality is affected*) |
222-
| `chore` | Changes to build process or auxiliary tools | None |
223-
| `ci` | Changes to CI configuration files and scripts | None |
221+
| `build` | Changes to the build/CI process, auxilary tools, or external dependencies | None (*unless functionality is affected*) |
224222
| `docs` | Documentation changes | None |
225223
| `feat` | A new feature | MINOR (`x.Y.z`) |
226224
| `fix` | A bug fix | PATCH (`x.y.Z`) |
227225
| `perf` | Changes that improve performance | PATCH (`x.y.Z`) |
228-
| `refactor` | Code changes that neither fix a bug nor add a feature | None (*unless functionality is affected*) |
226+
| `refactor` | Code changes that improve code quality but have no functional effect | None (*unless functionality is affected*) |
229227
| `revert` | Reverts a previous commit | Depends on the reverted change |
230-
| `style` | Changes that don't affect code meaning (formatting, etc) | None |
231228
| `test` | Adding or correcting tests | None |
232229

233230
> [!NOTE]

0 commit comments

Comments
 (0)