-
Notifications
You must be signed in to change notification settings - Fork 493
Commit message guidelines
Here are some tips to follow about your commits messages:
Tools like rebase could not work properly otherwise.
If this commit fixes an issue you need to mention it like Fixes #1234. Ideally the reference will be added when your pull request is ready to be merged, so that we don't flood the issue with references, while working on the pull request
If the commit has more than one author tag them with Co-authored-by: name <[email protected]>.
The commit subject should not be longer than 50 characters and should not end with a period (.). Each line of the commit body should not be longer than 72 characters.
Commit messages should be written in the imperative mood, starting with a word like 'Fix' or 'Add' or 'Change'
Want to know more about what people consider good commit message style? Read one
- Chris Beams - How to Write a Git Commit Message