Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/papis/python-doi/issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Fix Bugs / Implement Features¶
Look through the GitHub issues for bugs or feature requests. Anybody is welcome to submit a pull request for open issues.
Write Documentation¶
python-doi could always use more documentation, whether as part of the official python-doi docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/papis/python-doi/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 :)
Get Started!¶
In short,
Clone the repository from
git@github.com:papis/python-doi.git
Fork the repo on GitHub to your personal account.
Add your fork as a remote.
Pull in the latest changes from the master branch.
Create a topic branch
Make your changes and commit them (testing locally)
Push changes to the topic branch on your remote
Make a pull request against the base master branch through the Github website of your fork.
The project contains a Makefile
to help with development tasts. In your checked-out clone, do
$ make help
to see the available make targets.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
Check https://travis-ci.org/papis/python-doi/pull_requests and make sure that the tests pass for all supported Python versions.