Skip to content


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

Report Bugs

Report bugs at

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" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "Feature request" is open to whoever wants to implement it.

Write Documentation

The project could always use more documentation, whether as part of the official project docs, 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

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. :)


Feel free to discuss with our community through our discussions channel. Be polite!

Dev Environment Setup

We use some tools as part of our development workflow which you'll need to install into your host environment:

  • Poetry v1.2+ for packaging and dependency management

Or you can use Gitpod ready-to-code to start hacking with one click!

Get Started!

Ready to contribute? Here's how to set up the project for local development.

  1. Fork the Copier repo on GitHub.
  2. Clone your fork locally:

    git clone
    cd copier
  3. Use Poetry to set up a development environment:

    # Tell Poetry to create the virtualenv in the project directory
    poetry config true --local
    # Create a virtualenv with all dependencies from pyproject.toml
    poetry install --with docs
    # Install development helper tools
    poetry run pre-commit install -t pre-commit -t commit-msg
    # Create a new shell with the virtualenv activated
    poetry shell
  4. Create a branch for local development:

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

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass all tests:

    poe test
    poe lint

    To have multiple Python versions on the same machine for running tox, I recommend using pyenv (do not confuse it with pipenv,).

  6. Commit your changes and push your branch to GitHub:

    git add .
    cz commit  # use `git commit` if you prefer, but this helps
    git push origin name-of-your-bugfix-or-feature
  7. 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 has code, it should include tests.
  2. Check that all checks pass on GitHub CI.


To run a subset of tests:

poe test tests/
Back to top