- Explain what, then why, but not how.
- Use a short descriptive subject.
- Write in present tense, imperative voice.
- Put additional details in the body.
- Start subjects with a capital, but do not end with a period.
- Keep subjects roughly less than 50 characters.
- Separate the subject and body with a blank line.
- Wrap the body to roughly 72 characters.
If applied, this commit will...
- Query transactions for a set of addresses
- Include stack trace with error messages
- Refactor subsystem X for readability
- Update getting started documentation
- Remove deprecated methods
- Release version 1.0.0
- Fixed the bug with the server
- Forgot to include this.
- Updating the API.
- Improvements.
Read https://chris.beams.io/posts/git-commit/ for more.