-
Notifications
You must be signed in to change notification settings - Fork 107
Commit message rules
Warren Zhu edited this page Aug 2, 2018
·
2 revisions
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
- Try to your best to explain commit's purpose without looking at the change
- If commit refers some issue. Suffix
Fix #100
such asRefactor something. Fix #100
Any commit message violates such rule need to be rewritten.
- The Art of the Commit - http://alistapart.com/article/the-art-of-the-commit
- How to Write a Git Commit Message - https://chris.beams.io/posts/git-commit/
- One commit, one change https://medium.com/@fagnerbrack/one-commit-one-change-3d10b10cebbf