Skip to content

Latest commit

Β 

History

History
39 lines (33 loc) Β· 1.67 KB

CONTRIBUTING.md

File metadata and controls

39 lines (33 loc) Β· 1.67 KB

Styleguides

Developer Certificate of Origin

Please read the Developer Certificate of Origin before contributing. The project is licensed under MIT.

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 πŸ˜ƒ :
    • 🎨 :art: when improving the format/structure of the code
    • πŸš€ :rocket: when improving performance
    • πŸ’‘ :bulb: new idea
    • πŸ“š :books: To add new reference
    • 🚧 :construction: work in progress
    • πŸ’» :computer: when adding feature
    • βž– :heavy_minus_sign: when removing feature
    • 🚱 :non-potable_water: when plugging memory leaks
    • ✏️ :pencil2: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when closing pull requests
    • πŸ› :bug: when fixing a bug
    • πŸ”₯ :fire: when removing code or files
    • πŸ’š :green_heart: when fixing the CI build
    • 🎯 :dart: when adding tests
    • πŸ”’ :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • πŸ”ˆ :speaker: when adding logging
    • πŸ”‡ :mute: when reducing logging
    • πŸ‘• :shirt: when removing linter warnings
    • πŸ”¨ :hammer: Refactor