Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 2.22 KB
Raw

Contributions are highly appreciated

All contributors will be granted credit on the following list

You can help out by:

  • Reporting a bug
  • Reviewing the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Branches

We're using the following branches to manage work:

  • develop is semi-stable and should be used as the branch to fork from
  • master is stable and ready for prod (or it will be once we merge in the first release)
  • feature, bug branches: unstable development

How to report bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

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 to happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

We <3 thorough bug reports.

How to contribute code

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase. We use a loose version of Git Flow and actively welcome your pull requests:

  1. Set up your local development environment. See README.md for instructions.
  2. Create a new branch based on develop:
    • Feature branches should start with feature/
    • Bugfix branches should start with bug/
  3. Implement your changes.
  4. Add tests if applicable.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the GNU General Public License v3.0

When you submit code changes, your submissions are understood to be under the same GPL-3.0 that covers the project.