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
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:
- Fork the repo and create your branch from
master
. - Test your changes
- Ensure the test suite passes.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same GNU General Public Licence that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using YATA's Discord
We use YATA's discord to track any and all issues
Great issue 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)
People love thorough issue reports. I'm not even kidding.
YATA's GitHub repo uses pre-commit to ensure everything remains consistent.
Before making any commits or pull requests we recommend that you enable this in your development environment.
pip install pre-commit
pre-commit install
By contributing, you agree that your contributions will be licensed under its GNU General Public Licence.
This document was adapted from the open-source contribution guidelines for Facebook's Draft