Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 1.52 KB

Contributing to Band-aid

💡🎉 First off, thanks for taking the time to contribute! 🎉💡

Table Of Contents

Styleguides

Styleguides

Branch names

  • The branch name all starts with [fix, add, remove, refactor]

Git Commit Messages

  • Limit the first line to 72 characters or less
  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable emoji
    • 🆕 :new: when add code or file(s)
    • 💩 :poop: when add code or file(s) that needs refactor later
    • 🎨 :art: when improving the format/structure of the code
    • 🚀 :rocket: when improving performance
    • 📖 :book: when writing docs
    • 🔤 :abc: when renamining or fixing syntax errors
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or file(s)
    • 💚 :green_heart: when fixing the CI build
    • 🚥 :traffic_light: when adding tests
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • :x: when removing dependencies
    • 👕 :shirt: when improving or fixing linters

Documentation Styleguide