Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 1.75 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 maintainer

Our Development Process

We use GitHub to host code, manage the project, host documention, use CI/CD, to tracking issues and feature requests, as well as accepting pull requests.

We Follow 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 main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  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

In short, when you submit code changes, your submissions are understood to be under the same GNU General Public License v3.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Request features and report bugs using GitHub issues

We use GitHub issues to track bugs, features and questions, while GitHub projects are used to track progress using Kanban style boards. Try opening a new issue following one of the predefined templates; it's that easy!

License

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