Contributions are welcome and greatly appreciated! Every little bit helps, and credit will always be given.
How to Contribute¶
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Pipenv Pipes could always use more documentation, whether as part of the official Pipenv Pipes 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://github.com/gtalarico/pipenv-pipes/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.
Setup Pipes Development Environment¶
Ready to contribute? Here’s how to set up Pipes for local development.
- Fork the the Pipes repository from GitHub.
- Clone your fork locally:
$ git clone email@example.com:YOUR_GITHUB_USERNAME/pipenv_pipes.git
- Create a virtualenvironment - we will use Pipenv:
$ cd pipenv_pipes $ pipenv install --dev $ python setup.py develop
- Create a branch for local development so you can make your changes locally:
$ git checkout -b name-of-your-bugfix-or-feature
- When you’re done making changes, check that your changes pass all tests. See the Testing section below for more details on testing.
- 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.
Run test suite¶
Tests use Pytest. To run the test suite run:
$ pytest or $ python setup.py test or
Make sure the code follows Flake 8 standard by using a linter within your code editor or use the command below:
$ flake8 pipenv_pipes tests
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.
- The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/gtalarico/pipenv_pipes/pull_requests and make sure that the tests pass for all supported Python versions.
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bump2version major / minor / patch / release $ git push $ git push --tags
Travis should run all tests but integration with PyPI is currently disabled.
To deploy to Pypi use