Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://bitbucket.org/spookylukey/signupto/issues.
If you are reporting a bug, please include:
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix bugs and implement features¶
Look through the BitBucket issues for bugs or features that you want to tackle.
There are no tests yet, and they are a bit tricky to do, as you really have to test a client library like this against the actual web service, which has no sandbox. Testing strategies will probably depend on how well requests can be mocked out.
signupto could always use more documentation, whether as part of the official signupto docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://bitbucket.org/spookylukey/signupto/issues
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up signupto for local development.
Fork the signupto repo on BitBucket.
Clone your fork locally:
$ hg clone ssh://email@example.com/your_name_here/signupto
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv signupto $ cd signupto/ $ python setup.py develop
Create a branch for local development:
$ hg branch name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass the tests, including testing other Python versions with tox:
You will need to:
$ pip install tox
Commit your changes and push your branch to BitBucket:
$ hg record $ hg push
Submit a pull request through the BitBucket website.