Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 1.87 KB
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing. These are just guidelines, not rules, use your best judgment and feel free to propose changes.

  • Reporting bugs
  • Writing code
  • Contributing new code to the project
  • Discussing features
  • Code of conduct

Reporting bugs

Please use the Github Issues and fill out the template to make good bug reports.

Contributing new code

Please see the Getting Started Guide to get setup and running.

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

We Use Github Flow, So All Code Changes Happen Through Pull Requests Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. Write tests for your code.
  3. Write code that passes your tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes.
  6. Send in your pull request.
  7. Discuss the changes with the team.
  8. Get the code approved and merged into the master branch.

License

By sending in new code you agree that it will be covered by the existing license - GNU General Public License v2.0.

Discussing features

Please use Github discussions to learn and talk about the future features and direction for the project.

Code of conduct

It's not hard: Don't be a jerk.