Skip to content

Commit

Permalink
Clarify appropriate case and punctuation for commit messages
Browse files Browse the repository at this point in the history
  • Loading branch information
CoffeeCoder1 authored Jan 9, 2025
1 parent 4f7bc67 commit fe1b653
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/git-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The main branch MUST remain stable. Any changes that are made MUST be made on a

Changes to the code MUST be committed frequently and incrementally to make narrowing down problems while testing code easier (reverting commits is easy, reverting changes within a commit is not). You MUST NOT commit once at the end of the day with a message like `End of practice` or `End of day 1`.

Commit messages MUST provide a clear and concise description of everything that the commit does, and commit descriptions MAY be used whenever more description is needed and to explain the reason why changes were made.
Commit messages MUST provide a clear and concise description of everything that the commit does, and commit descriptions MAY be used whenever more description is needed and to explain the reason why changes were made. Commit messages SHOULD be in sentence case without any punctuation and commit descriptions SHOULD be in sentence case with appropriate punctuation.

When committing from the programming laptop, you SHOULD add yourself as a co-author by appending `Co-Authored By: Name <E-mail>` to the end of your commit message (this can be done in GitHub Desktop by clicking the `Add Co-Authors` button in the lower left corner of the description).

Expand Down

0 comments on commit fe1b653

Please sign in to comment.