Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.49 KB
Raw

Contributing

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 contributor

We Develop with Github

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 Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, test it.
  3. Ensure your commits has descriptive text.
  4. Issue that pull request!

Any contributions you make will be under the GNU GPLv3 License

In short, when you submit code changes, your submissions are understood to be under the same GNU GPLv3 license that covers the project.

Reporting 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, this makes it a lot easier to understand the issue.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce. Be specific!
  • 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)