-
Notifications
You must be signed in to change notification settings - Fork 0
Git Commit Guidelines
Marvin Pohl edited this page Mar 15, 2015
·
3 revisions
We are using the same commit guidelines as the Atom project.
Taken from https://atom.io/docs/latest/contributing#git-commit-messages:
- 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:
- π
:lipstick:
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 :octocat:
when changing git related stuff (gitignore, gitattributes, hooks etc...)- β‘
:zap:
when doing massive changes which breaks old stuff
- π
- [Git Commit Guidelines](Git Commit Guidelines)
- [Branching Model](Branching Model)
- Project Structure & Coding Conventions
- Tutorials
- Third Party Libraries