Skip to content

Latest commit

Β 

History

History
38 lines (31 loc) Β· 1.74 KB

CONTRIBUTING.md

File metadata and controls

38 lines (31 loc) Β· 1.74 KB

Contributing

πŸ‘πŸŽ‰ First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘

This contributing guide is loosely borrowed from the Atom project

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Don't end commit message in a period
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable "gitmoji":
    • 🎨 :art: when improving the format/structure of the code
    • ⚑ :zap: when improving performance
    • ✨ :sparkles: when introducing new features
    • πŸ“ :pencil: when writing docs
    • ✏️ :pencil2: when fixing typos
    • πŸ› :bug: when fixing a bug
    • πŸ”₯ :fire: when removing code or files
    • 🚚 :truck: when moving or renaming files
    • πŸ’š :green_heart: when fixing the CI build
    • βœ… :white_check_mark: when adding or updating tests
    • πŸ”’ :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 🚨 :rotating_light: when removing linter warnings
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows