Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Latest commit

 

History

History
58 lines (43 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

58 lines (43 loc) · 2.62 KB

Contributing

👍👍👍 First and foremost, thanks for helping! 👍👍👍

Building for development

The standard gulp task builds opmtimised JavaScript, HTML and CSS, which can make debugging tricksy. To build non-optimised output, use the build:develop gulp task.

The build:develop and build:optimise tasks do not run the test suite, as you will often want to run this separately, watching for changes and running the tests on every change:

karma start

Issues

  • Issues are appropriate for questions, bug requests, enhancement requests, pretty much anything.

Pull Requests

  • PRs should be from your fork of the project, into a feature or hotfix branch (see 'Branches' below).
  • If you've added code that should be tested, add tests!
  • If you've changed APIs, update the documentation.
  • Ensure the test suite passes (gulp test).
  • Make sure your code lints (gulp lint).
  • Ensure the code you're submitting can be released under our license.

Branches

This project uses Git Flow branching strategy.

  • master is reserved for releases.
  • develop contains the latest stable development code. It is merged into master by PR to perform a release.

Git Commit Messages

These are lifted liberally from the Atom contributing guidelines.

  • 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:
    • 🎨 :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
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings