Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
When creating a new issue, please be as specific as possible. Include the version of the code you were using. If possible, include complete, minimal example code that reproduces the problem.
We love pull requests from everyone. Fork, then clone the repo:
git clone git@github.com:your-username/siphon.git
Install siphon:
python setup.py install
Install pytest and make sure the tests pass:
pip install pytest
py.test
Make your change. Add tests for your change. Make the tests pass:
py.test
Push to your fork and submit a pull request.
At this point you're waiting on us. You should expect to hear at least a comment within a couple of days. We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Follow PEP8 for style. (The
flake8utility can help with this.) - Write a good commit message.
Pull requests will automatically have tests run by Travis. This includes running both the unit
tests as well as the flake8 code linter.