Contributing to Poutyne
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.
Github Flow, So All Code Changes Happen Through Pull RequestsWe Use
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
- If you've added code that should be tested, you must ensure it is properly tested.
- If you've changed APIs, update the documentation.
- Ensure the Travis test suite passes.
- Make sure your code lints.
- Submit that pull request!
Any contributions you make will be under the GPLv3 Software License
In short, when you submit code changes, your submissions are understood to be under the same GPLv3 License that covers the project. Feel free to contact the maintainers if that's a concern.
Write bug reports with detail, background, and sample code
We use GitHub issues to track public bugs. Report a bug by opening a new issue. You should use one of our proposed templates when appropriate; they are integrated with GitHub and do most of the formatting for you. It's that easy!
Great Bug Reports tend to have:
- A quick and clear summary and/or background
- Steps to reproduce
- Be specific and clear!
- Give sample code if you can. Try to reduce the bug to the minimum amount of code needed to reproduce: it will help in our troubleshooting procedure.
- 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) Feel free to include any print screen or other file you feel may further clarify your point.
Do you have a suggestion for an enhancement?
We use GitHub issues to track enhancement requests. Before you create an enhancement request:
Make sure you have a clear idea of the enhancement you would like. If you have a vague idea, consider discussing it first on the users list.
Check the documentation to make sure your feature does not already exist.
Do a quick search to see whether your enhancement has already been suggested.
When creating your enhancement request, please:
Provide a clear title and description.
Explain why the enhancement would be useful. It may be helpful to highlight the feature in other libraries.
Include code examples to demonstrate how the enhancement would be used.
Use a Consistent Coding Style
yapf poutyne --recursive --in-place yapf tests --recursive --in-place
We also have our own
pylint config file. Try not to introduce code incoherences detected by the linting. You can run the linting procedure with
pylint poutyne pylint tests
If your pull request introduces a new feature, please deliver it with tests that ensure correct behavior. All of the current tests are located under the
tests folder, if you want to see some examples.
For any pull request submitted, ALL of the tests must succeed. You can run the tests with
When submitting a pull request for a new feature, try to include documentation for the new objects/modules introduced and their public methods.
All of Poutyne's html documentation is automatically generated from the Python files' documentation. To have a preview of what the final html will look like with your modifications, first start by rebuilding the html pages.
cd docs ./rebuild_html_doc.sh
You can then see the local html files in your favorite browser. Here is an example using Firefox:
By contributing, you agree that your contributions will be licensed under its GPLv3 License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft.