Skip to content

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::octocat: when changing git related stuff (gitignore, gitattributes, hooks etc...)
    • ⚑:zap: when doing massive changes which breaks old stuff

General

Development

Game Design

Clone this wiki locally