Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

56 lines (43 loc) · 2.57 KB
Raw

Contributing

Anyone can contribute to this repo, so long as you don't break anything on purpose.

Bug reporting

Please report any errors you're having with clear steps to reproduce. Screenshots can help a lot.

Bug fixes

If you find any sort of error, spelling mistak, etc. in this project, feel free to fix it and submit a pull request with your commit. Little fixes like this are welcomed and are usually accepted pretty quickly.

Feature requests

Time is limited, so feature requests are discussed and released when possible and time permits. You can always send a pull request to speed up the process.

Code style

Many conventions are available for writing code, but in this repo there's only one correct and that's mine :)

Please use the following conventions:

  • Tabs over spaces.
  • My tabs are 4 spaces width.
  • Always append JavaScript with an ;.
  • End files with a newline.
  • Try to obey JSHint rules.
  • Install EditorConfig to help with above and more rules.
  • Follow the conventions you see used in the source already.

Git Commit Messages

  • Use the past tense ("Added feature" not "Add feature").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.
  • Consider starting the commit message with an applicable emoji:
    • 🐛 :bug: when fixing a bug.
    • ✨ :sparkles: when adding a new feature.
    • 🎨 :art: when improving the format/structure of the code.
    • 📝 :memo: when writing docs.
    • 🔍 :mag: when adding debugging code.
    • 🔥 :fire: when removing code or files.
    • 🐎 :racehorse: when improving performance.
    • 🚱 :non-potable_water: when plugging memory leaks.
    • 💚 :green_heart: when fixing the CI build.
    • ✅ :white_check_mark: when adding tests.
    • 🔒 :lock: when dealing with security.
    • 👕 :shirt: when removing linter warnings.
    • 📦⬆️ :package::arrow_up: when upgrading dependencies.
    • 📦⬇️ :package::arrow_down: when downgrading dependencies.
    • 🎬 :clapper: for the initial commit and project snapshots.
    • 🔜 :soon: for TODO messages.
    • 🏁 :checkered_flag: when fixing something on Windows.
    • 🐧 :penguin: when fixing something on Linux.
    • 🍎 :apple: when fixing something on Mac OS.