Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1.39 KB
Raw

Contributing Guide

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Reporting Bugs

Report bugs right through the GitHub issue tracker.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce, be specific!
  • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Submitting Changes

We use GitHub Flow!

  1. Fork from master
  2. Name your branch something specific to your contribution. e.g. fix-this-bug
  3. If you have changed APIs, update the documentation
  4. Issue your PR once you are ready for code review

Style

We use StandardJS style guide, this means two spaces for indenting. There are StandardJS packages for most editors out there as well as a command line tool to check before you submit any PRs. Linting CI is set up, so we will see this right away.

License

By contributing, you agree that your contributions will be licensed under the GNU General Public License v3.0.