Not implemented todo
Thats great, we are happy that you want to contribute
Some resources to start
- Join us on Gitter to chat!
- Look at our milestones and projects on GitHub for an idea on where development is headed
- Look at open issues tagged with "help" and "good first issue"
- Look at the development guide in our documentation
Not implemented todo
By contributing e.g. through opening a pull request or submitting a patch, you represent that your contributions are your own original work and that you have the right to license them, and you agree that your contributions are licensed under the Apache 2.0 license.
Not implemented todo
Open an issue on GitHub to report bugs or other problems.
If reporting an error when running please include a full traceback in your issue.
Not implemented todo
Look at the development guide in our documentation for information on how to get set up for development.
To contribute changes:
- Fork the project on GitHub
- Create a feature branch to work on in your fork (
git checkout -b new-fix-or-feature
) - Add your name to the
AUTHORS
file - Commit your changes to the feature branch
- Push the branch to GitHub (
git push origin new-fix-or-feature
) - On GitHub, create a new pull request from the feature branch
Our development guide gives a more detailed description of each step, if you're new to working with GitHub.
Not implemented todo
Before submitting a pull request, check whether you have:
- Added your changes to
changelog.rst
- Added or updated documentation for your changes
- Added tests if you implemented new functionality
When opening a pull request, please provide a clear summary of your changes!
Not implemented todo
Please try to write clear commit messages. One-line messages are fine for small changes, but bigger changes should look like this:
A brief summary of the commit
A paragraph or bullet-point list describing what changed and its impact,
covering as many lines as needed.
Not implemented todo
All tests are in the test
directory and use
Not implemented todo
The layout and content of this document is partially based on the calliope-project.