Skip to content

Commit 88cb445

Browse files
committed
docs: add CONTRIBUTING.md
1 parent 6d3e864 commit 88cb445

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to this project!
4+
5+
## Development
6+
7+
1. Fork the repository
8+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
9+
3. Make your changes
10+
4. Commit your changes using conventional commits
11+
5. Push to the branch (`git push origin feature/amazing-feature`)
12+
6. Open a Pull Request
13+
14+
## Commit Convention
15+
16+
This project uses [Conventional Commits](https://www.conventionalcommits.org/). Please format your commit messages as:
17+
18+
```
19+
<type>: <description>
20+
21+
[optional body]
22+
```
23+
24+
Examples:
25+
- `feat: add user authentication`
26+
- `fix: resolve memory leak in worker process`
27+
- `docs: update API documentation`
28+
29+
## Changelog
30+
31+
The changelog is automatically generated using [git-cliff](https://git-cliff.org/). To update the changelog:
32+
33+
```bash
34+
git-cliff --output CHANGELOG.md
35+
```
36+
37+
The changelog follows the [Keep a Changelog](https://keepachangelog.com/) format and includes GitHub integration for PR links and contributor recognition.

0 commit comments

Comments
 (0)