Contributing to docs-template¶
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 Develop with Github¶
We use github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow¶
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. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
Any contributions you make will be under the specified Software License¶
License contents are located in LICENSE.md file.
In short, when you submit code changes, your submissions are understood to be under the same license that covers the project.
Feel free to contact the maintainers if that's a concern.
Report bugs via Github Issues¶
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
Use a Consistent Coding Style¶
Automated linters and checkers are run on each Pull Request in order to ensure consistent styling across the codebase.
Please do not merge without resolving these issues first!
License¶
By contributing, you agree that your contributions will be licensed under the aforementioned license.
References¶
This document was adapted from the open-source contribution guidelines created by Brian A. Danielak