Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

30 lines (24 loc) · 1.29 KB
Raw

Contribution Guide

A rough guide for keeping a consistent project style

Style Guides

Typescript

All TypeScript must adhere to the JavaScript Standard Style, it isn't officially endorsed by Ecmascript someone just called it that. This style is set up with tslint so it should be easy to follow.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Moves cursor to..." not "Moved cursor to...")
  • Use the first line (72 letters) as a general description then bullet changes on subsequent lines with an *
    • Unless you change something really small
  • Consider starting the commit message with an applicable emoji:
    • ⭐ :star when adding new features
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies