Skip to content

Commit 8107d4f

Browse files
committed
📝(contributing) add changelog part in contributing
We add a new section in the CONTRIBUTING.md file to explain how to update the CHANGELOG.md file. We improve the pull request section as well.
1 parent f8c8044 commit 8107d4f

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ All commit messages must adhere to the following format:
2020

2121
`<gitmoji>(type) title description`
2222

23-
* **<gitmoji>**: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list here: <https://gitmoji.dev/>.
23+
* <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list here: <https://gitmoji.dev/>.
2424
* **(type)**: Describe the type of change. Common types include `backend`, `frontend`, `CI`, `docker` etc...
2525
* **title**: A short, descriptive title for the change, starting with a lowercase character.
2626
* **description**: Include additional details about what was changed and why.
@@ -33,9 +33,28 @@ All commit messages must adhere to the following format:
3333
Implemented login and signup features, and integrated OAuth2 for social login.
3434
```
3535

36+
## Changelog Update
37+
38+
Please add a line to the changelog describing your development. The changelog entry should include a brief summary of the changes, this helps in tracking changes effectively and keeping everyone informed. We usually include the title of the pull request, followed by the pull request ID to finish the log entry. The changelog line should be less than 80 characters in total.
39+
40+
### Example Changelog Message
41+
```
42+
## [Unreleased]
43+
44+
## Added
45+
46+
- ✨(frontend) add AI to the project #321
47+
```
48+
3649
## Pull Requests
3750

38-
It is nice to add information about the purpose of the pull request to help reviewers understand the context and intent of the changes.
51+
It is nice to add information about the purpose of the pull request to help reviewers understand the context and intent of the changes. If you can, add some pictures or a small video to show the changes.
52+
53+
### Don't forget to:
54+
- check your commits
55+
- check the linting: `make lint && make frontend-lint`
56+
- check the tests: `make test`
57+
- add a changelog entry
3958

4059
Once all the required tests have passed, you can request a review from the project maintainers.
4160

0 commit comments

Comments
 (0)