- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- Consider starting the commit message with an applicable emoji:
- π¨
:art:when improving the format/structure of the code - π
:racehorse:when improving performance - π±
:non-potable_water:when plugging memory leaks - π
:memo:when writing docs - π§
:penguin:when fixing something on Linux - π
:apple:when fixing something on Mac OS - π
:checkered_flag:when fixing something on Windows - π
:bug:when fixing a bug - π₯
:fire:when removing code or files - π
:green_heart:when fixing the CI build - β
:white_check_mark:when adding tests - π
:lock:when dealing with security - β¬οΈ
:arrow_up:when upgrading dependencies - β¬οΈ
:arrow_down:when downgrading dependencies - π
:shirt:when removing linter warnings
- π¨
Based on https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages