Skip to content

Commit b63a144

Browse files
committed
Merge pull request #5 from NataliaLKB/aesthetics
Making the commit message guidelines into bullet points for quick readin...
2 parents e7edd79 + 34bc9d5 commit b63a144

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -378,12 +378,14 @@ Likewise, even in pull requests, you must aim to make your commits a clear and c
378378
### Commit messages
379379
380380
Just like choosing when to commit, and what to commit, it is also important to think about your naming. It is always good to be as descriptive as possible with your commit messages.
381+
381382
Also consider:
382-
Present tense for your commit messages
383-
If related to an issue on github, should contain issue number
384-
The first line should be 50 characters or less. Your message should be brief and to the point.
385-
Focus on why you did something, not how you did it
386-
Avoid `ands` . If you find yourself wanting to write `and`, you should probably break up that commit into multiple ones.
383+
* Present tense for your commit messages
384+
* If related to an issue on github, should contain issue number
385+
* The first line should be 50 characters or less. Your message should be brief and to the point.
386+
* Focus on why you did something, not how you did it
387+
* Avoid `ands`. If you find yourself wanting to write `and`, you should probably break up that commit into multiple ones.
388+
387389
Remember that the purpose of this commit is to be a message for future you, or your colleagues who may have not known what you are working on. Try to think about your message with this in mind.
388390
389391
Many development teams take it one step further and turn their commit messages into change logs. These change logs may be used for user consumption making it all the more important to have clear messages of what was done for that commit.

0 commit comments

Comments
 (0)