We want to make contributing to this project as easy and transparent as possible.
sparts is maintained and developed in the open, on github. It's designed to be easily extensible and to contain common APIs for rapid development of other projects, which may reside in separate repositories as necessary.
In general, if a task or module is generic enough, it should be in sparts. Unit tests are strongly encouraged and should be included with your pull requests. Case classes to make testing even easier to write are provided with the sparts source code.
Send us your pull requests, and we'd be happy to provide feedback and merge as appropriate.
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.
- If your bugfix or feature is significant, update CHANGES.txt for the unreleased revision
- Ensure the test suite passes.
- Make sure your code lints (e.g., pyflakes, PEP8, etc)
- If you haven't already, complete the Contributor License Agreement ("CLA").
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.
Complete your CLA here: <https://developers.facebook.com/opensource/cla>
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
- PEP-8 compliant
- General pyFlakes compliance (e.g., no * imports)
By contributing to sparts, you agree that your contributions will be licensed under its BSD license.