From fe1b653bf4d3e70c711054ce7cb631f0158f9b5c Mon Sep 17 00:00:00 2001 From: Apollo Nargang Date: Thu, 9 Jan 2025 08:06:04 -0500 Subject: [PATCH] Clarify appropriate case and punctuation for commit messages --- docs/git-workflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/git-workflow.md b/docs/git-workflow.md index fa14228..3c1b330 100644 --- a/docs/git-workflow.md +++ b/docs/git-workflow.md @@ -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 ` 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).