Skip to content

Commit 9e34189

Browse files
committed
docs(contributing): add commit message convention guide
Added documentation explaining the conventional commit format used in this project. This helps contributors understand the required commit message structure.
1 parent ec33913 commit 9e34189

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

.github/COMMIT_CONVENTION.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Commit Message Convention
2+
3+
This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
4+
5+
## Format
6+
7+
```
8+
type(scope): subject
9+
10+
body
11+
12+
footer
13+
```
14+
15+
## Types
16+
17+
- `feat`: A new feature
18+
- `fix`: A bug fix
19+
- `docs`: Documentation changes
20+
- `style`: Code style changes (formatting, missing semi-colons, etc.)
21+
- `refactor`: Code refactoring
22+
- `perf`: Performance improvements
23+
- `test`: Adding or updating tests
24+
- `build`: Changes to build system or dependencies
25+
- `ci`: Changes to CI configuration
26+
- `chore`: Other changes that don't modify src or test files
27+
28+
## Examples
29+
30+
```
31+
docs(readme): add installation instructions
32+
33+
feat(auth): implement JWT authentication
34+
35+
fix(api): resolve null pointer exception in user endpoint
36+
```
37+
38+
## Validation
39+
40+
All commits are validated using commitlint with the conventional config.
41+
See `commitlint.config.js` for configuration details.

0 commit comments

Comments
 (0)