- Don't underestimate the importance of Git history - write good commit messages!
- Reference issues and pull requests
- Consider starting the commit message with an applicable emoji (based on Atom's contribution guidelines and gitmoji):
- π
:racehorse:
when improving performance - π±
:non-potable_water:
when plugging memory leaks - π
:memo:
when writing docs - π
:bug:
when fixing a bug - π₯
:fire:
when removing code or files - π
:green_heart:
when fixing the CI build - π³
:whale:
when adding or changing Docker-related things - β¨
:sparkles:
when writing tests for a new feature (TDD) - π€‘
:clown_face:
when mocking out dependencies - β
:white_check_mark:
when fixing tests by actually introducing a feature (TDD) - β»οΈ
:recycle:
when refactoring - π
:lock:
when dealing with security - π
:shirt:
when improving code style - β
:heavy_plus_sign:
when adding a dependency - β
:heavy_minus_sign:
when removing a dependency - π§
:wrench:
when changing configuration - π
:truck:
when moving files - π
:sound:
when adding logging - π
:mute:
when removing logging - ποΈ
:building_construction:
when making design changes - ποΈ
:card_file_box:
when changing database-related stuff - π¨βπ»
:man_technologist:
or π©βπ»:woman_technologist:
when setting up or changing project's [development] environment - π
:rocket:
when bootstrapping a new project - πΊοΈ
:world_map:
when designing an API
- π