Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Report bugs at https://github.com/copier-org/copier/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" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "Feature request" is open to whoever wants to implement it.
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.
The best way to send feedback is to file an issue at https://github.com/copier-org/copier/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 :)
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 for packaging and dependency management
- poethepoet for running development tasks
- commitizen for writing git commits easily
Ready to contribute? Here's how to set up the project for local development.
- Fork the copier repo on GitHub.
Clone your fork locally:
git clone firstname.lastname@example.org:my-user/copier.git cd copier
Use poetry to setup a development environment
# Tell Poetry to create the virtualenv in the project directory poetry config virtualenvs.in-project true --local # Create a virtualenv with all dependencies from pyproject.toml poetry install -E 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
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 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
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
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request has code, it should include tests.
- Check that all checks pass on GitHub CI
To run a subset of tests:
poe test tests/the-tests-file.py