Skip to content

Commit d7afca1

Browse files
enkoclaude
andcommitted
docs(docs): Align git-workflow.md with commitlint config
Subject case, types, and scopes in the documentation were out of sync with commitlint.config.mjs. Updated to sentence case, added missing types (build, ci, revert), and added missing scopes (all, deps, config, dx, release). Renamed db to database to match the config. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 30ae33f commit d7afca1

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

docs/git-workflow.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ All commits must follow the [Conventional Commits](https://www.conventionalcommi
3535
[optional footer]
3636
```
3737

38-
The description should be lowercase, imperative mood, and not end with a period. Think "add circle filtering" not "Added circle filtering."
38+
The description should be sentence case, imperative mood, and not end with a period. Think "Add circle filtering" not "Added circle filtering."
3939

4040
### Types
4141

@@ -48,44 +48,52 @@ The description should be lowercase, imperative mood, and not end with a period.
4848
| `refactor` | Code restructuring that neither fixes a bug nor adds a feature |
4949
| `perf` | A change that improves performance |
5050
| `test` | Adding or updating tests |
51-
| `chore` | Maintenance tasks, dependency updates, tooling |
51+
| `build` | Changes to build system or dependencies |
52+
| `ci` | Changes to CI configuration files and scripts |
53+
| `chore` | Other changes that don't modify src or test files |
54+
| `revert` | Reverts a previous commit |
5255

5356
### Scopes
5457

5558
| Scope | Covers |
5659
|-------|--------|
57-
| `frontend` | `apps/frontend` (SvelteKit) |
60+
| `all` | Affects everything |
5861
| `backend` | `apps/backend` (Node/Express) |
62+
| `frontend` | `apps/frontend` (SvelteKit) |
5963
| `shared` | `packages/shared` |
60-
| `db` | Database migrations and schema |
61-
| `ci` | CI/CD configuration |
64+
| `database` | Database migrations and schema |
6265
| `docs` | Documentation files |
66+
| `deps` | Dependency updates |
67+
| `config` | Configuration files |
68+
| `ci` | CI/CD configuration |
69+
| `dx` | Developer experience |
70+
| `release` | Semantic-release automated commits |
6371

6472
A commit that touches multiple scopes usually means it should be split into separate commits.
6573

6674
### Examples
6775

6876
```
69-
feat(frontend): add circle filtering to friend list
70-
fix(backend): handle missing email in registration flow
71-
refactor(shared): extract date formatting utilities
72-
docs: add git workflow guide
73-
chore(ci): update Node to v24
77+
feat(frontend): Add circle filtering to friend list
78+
fix(backend): Handle missing email in registration flow
79+
refactor(shared): Extract date formatting utilities
80+
docs: Add git workflow guide
81+
chore(ci): Update Node to v24
7482
```
7583

7684
### Breaking Changes
7785

7886
Breaking changes go in the commit footer:
7987

8088
```
81-
feat(backend): replace session tokens with JWTs
89+
feat(backend): Replace session tokens with JWTs
8290
8391
BREAKING CHANGE: existing sessions are invalidated on deploy
8492
```
8593

8694
### What to Avoid
8795

88-
-`fix(backend): resolve null pointer in auth middleware`
96+
-`fix(backend): Resolve null pointer in auth middleware`
8997
-`fixed stuff`
9098
-`WIP`
9199
-`update`

0 commit comments

Comments
 (0)