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