Skip to content

Commit

Permalink
fix: Add missing period to commit message example (#29312)
Browse files Browse the repository at this point in the history
Added a missing period to the body of the good commit message example to adhere to punctuation conventions and emphasize the difference between the subject and the body.
  • Loading branch information
ruizterce authored Jan 13, 2025
1 parent 7dd2dde commit f591c51
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions git/foundations_git/commit_messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ Now that we learned the secret to creating a good commit message, let's try and
```git
Add missing link and alt text to the company's logo
Screen readers won't read the images to users with disabilities without this information
Screen readers won't read the images to users with disabilities without this information.
```

Ahh, that's better! :) Now, developers can gain a better understanding of this commit message because it does the following:

- Provides a subject that specifies your code's action (e.g., "Add missing link and alt text to the company's logo").
- Contains a body that provides a concise yet clear description of why the commit needed to be made (e.g., "Screen readers won't read the images to users with disabilities without this information").
- Contains a body that provides a concise yet clear description of why the commit needed to be made (e.g., "Screen readers won't read the images to users with disabilities without this information.").
- Separates the subject from the body with a new/blank line. This is a best practice we highly recommend following. It makes commit messages easier for other developers to read.

### How to commit with a subject and body in the message
Expand Down

0 comments on commit f591c51

Please sign in to comment.