Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

26 lines (23 loc) · 1.33 KB

#Contributing to Solar

Follow the style guides from Dimensions.

Git Commit Messages

When making commits, it is improtant to have a commit message that explains what is in the commit.

  • 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:
    • :white_check_mark: when fixing typos
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on Mac OS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading/updating files
    • ⬇️ :arrow_down: when downgrading/rollback files