How to contribute to Plumbery?¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You are not a developer? We are glad that you are involved¶
You can contribute in many ways:
- submit feedback
- report bugs
- write documentation
- fix bugs
- implement features
The best way to send feedback is to file an issue. The place to go is Plumbery issues at GitHub. There you can check if your feedback is new, or if you can align with others.
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 :)
Have you identified some bug? Thanks to go to Plumbery issues at GitHub. This is the place where issues are documented, discussed, and fixed. We really value your time and effort to report bugs.
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.
Plumbery could always use more documentation, whether as part of the official plumbery docs, in docstrings, or even on the web in blog posts, articles, and such.
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Ready to contribute? Here’s how to set up Plumbery for local development¶
Fork the plumbery repo on GitHub. If you do not have an account there yet, you have to create one, really. This is provided for free, and will make you a proud member of a global community that matters. Once you have authenticated, visit the Plumbery repository at GitHub and click on the Fork link.
Clone your fork locally:
$ git clone firstname.lastname@example.org:your_name_here/plumbery.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv plumbery $ cd plumbery/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests:
$ make lint $ make test $ make coverage
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
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
- Check Plumbery continuous integration at Travis CI and make sure that the tests pass there.