Skip to content

Contributing

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/audreyr/cookiecutter-pypackage/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

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.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

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.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/cheeyeelim/cookiecutter-pypackage/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 :)

Get Started!

Ready to contribute? Here's how to set up cookiecutter-pypackage for local development. Please note this documentation assumes you already have Python and Git installed and ready to go.

Step 1: Fork the cookiecutter-pypackage repo on GitHub

Step 2: Clone your fork locally

1
2
cd path_for_the_repo
git clone git@github.com:YOUR_NAME/cookiecutter-pypackage.git

Step 3: Use poetry to manage environments

This will install latest version of poetry and install required packages in specified virtual environments.

1
2
3
4
5
pip install --upgrade pip
pip install poetry

cd cookiecutter-pypackage
poetry install -E dev

Step 4: Create a branch for local development

1
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

Step 5: Test the changes using tox

tox will run tests across different versions of Python and check to ensure documentation building works.

1
poetry run tox

Step 6: Add a new test to the existing test suite

If your contribution is a bug fix or new feature, you may want to add a test to the existing test suite. See section Add a New Test below for details.

Step 7: Commit your changes and push your branch to GitHub

1
2
3
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

Step 8: Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.

  2. 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.

  3. The pull request should work for Python 3.7, 3.8 and 3.9.

Add a New Test

When fixing a bug or adding features, it's good practice to add a test to demonstrate your fix or new feature behaves as expected. These tests should focus on one tiny bit of functionality and prove changes are correct.

To write and run your new test, follow these steps:

  1. Add the new test to tests/test_bake_project.py. Focus your test on the specific bug or a small part of the new feature.

  2. If you have already made changes to the code, stash your changes and confirm all your changes were stashed:

1
2
git stash
git stash list
  1. Run your test and confirm that your test fails. If your test does not fail, rewrite the test until it fails on the original code:
1
poetry run pytest ./tests
  1. Run the tests with tox to ensure that the code changes work with different Python versions:
1
poetry run tox
  1. Proceed work on your bug fix or new feature or restore your changes. To restore your stashed changes and confirm their restoration:
1
2
git stash pop
git stash list
  1. Rerun your test and confirm that your test passes. If it passes, congratulations!
Last update: 2021-12-20
Back to top