You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-2Lines changed: 21 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ All commit messages must adhere to the following format:
20
20
21
21
`<gitmoji>(type) title description`
22
22
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/>.
24
24
***(type)**: Describe the type of change. Common types include `backend`, `frontend`, `CI`, `docker` etc...
25
25
***title**: A short, descriptive title for the change, starting with a lowercase character.
26
26
***description**: Include additional details about what was changed and why.
@@ -33,9 +33,28 @@ All commit messages must adhere to the following format:
33
33
Implemented login and signup features, and integrated OAuth2 for social login.
34
34
```
35
35
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
+
36
49
## Pull Requests
37
50
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
39
58
40
59
Once all the required tests have passed, you can request a review from the project maintainers.
0 commit comments