Skip to content

Latest commit

Β 

History

History
42 lines (37 loc) Β· 2.15 KB

CONTRIBUTING.md

File metadata and controls

42 lines (37 loc) Β· 2.15 KB

Contribution Guidelines

Table of Contents

Styleguides

Commit Messages

  • 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