Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
When 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.
cookiecutter-pylibrary could always use more documentation, whether as part of the official cookiecutter-pylibrary 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/ionelmc/cookiecutter-pylibrary/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 :)
To set up cookiecutter-pylibrary for local development:
Clone your fork locally:
git clone git@github.com:your_name_here/cookiecutter-pylibrary.git
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 run all the checks and docs builder with tox one command:
tox
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.
If you need some code review or feedback while you're developing the code just make the pull request.
For merging, you should:
- Include passing tests (run
tox
) [1]. - Update documentation when there's new API, functionality etc.
- Add a note to
CHANGELOG.rst
about the changes.
[1] | If you don't have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though ... |
If you want to add a context option, you need to:
- Add the actual option in cookiecutter.json
- Add it in the cookiecutter test builder suite:
- Edit setup.cfg
- Run
./ci/bootstrap.py
to regenerate the test.cookiecutterrc
files.
- Change the bare tox.ini to have an conditional for it.
- Change the template tox.ini
(don't forget the raw sections) to have an conditional for it (this
tox.ini
file is used with thetest_matrix_configurator=yes
option)