Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/stdtom/cookiecutter-pypackage-pipenv/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.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Cookiecutter PyPackage could always use more documentation, whether as part of the official 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/stdtom/cookiecutter-pypackage-pipenv/issues.
If you are proposing a new 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 cookiecutter-pypackage for local development. Please note this documentation assumes you already have virtualenv and Git installed and ready to go.
- Fork the cookiecutter-pypackage repo on GitHub.
Clone your fork locally:
$ cd path_for_the_repo $ git clone git@github.com:YOUR_NAME/cookiecutter-pypackage.git
Assuming you have virtualenv installed (If you have Python3.5 this should already be there), you can create a new environment for your local development by typing:
$ virtualenv cookiecutter-pypackage-env $ source cookiecutter-pypackage-env/bin/activate
This should change the shell to look something like:
(cookiecutter-pypackage-env) $
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. Since, this package contains mostly templates the flake should be run for tests directory:
$ flake8 ./tests
The next step would be to run the test cases. cookiecutter-pypackage uses pytest, you can run PyTest. Before you run pytest you should ensure all dependancies are installed:
$ pip install -rrequirements_dev.txt $ pytest ./tests
If you get any errors while installing cryptography package (something like #include <openssl/aes.h>). Please update your pip version and try again:
# Update pip $ pip install -U pip
Before raising a pull request you should also run tox. This will run the tests across different versions of Python:
$ tox
If you are missing flake8, pytest and/or tox, just pip install them into your virtualenv.
- If your contributio