Skip to content

Commit

Permalink
docs: Update commit guidelines.
Browse files Browse the repository at this point in the history
If the commit message is very long, they should be
broken into multiple lines to make it easier to read.
  • Loading branch information
kuv2707 committed May 28, 2024
1 parent 0d43179 commit 64ead50
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- Use meaningful commit messages that describe the changes made in the commit.
- Please do only one thing in a single commit. If you are fixing a bug and refactoring some code, make two separate commits.
- If you make tweaks to existing code to fit your implementation, do it in a separate commit.
- Your commits would be more readable if each line is limited to around 72 characters. Break long lines into multiple lines if necessary.
- Commit messages should be of the format:
```
<area_of_code>: <short_description>
Expand Down

0 comments on commit 64ead50

Please sign in to comment.