Skip to content

Setup the repository with recommended settings

When the repository has been created, it will require some settings to be changed for all the features of python-copier-template to work. These are listed below.

Discussions

The contributing guide for the template recommends that new users start a discussion for questions. You can enable this feature by navigating to your repository page and:

  • Visiting Settings > General
  • Scrolling down to Features
  • Enabling it as shown

Setup GitHub Features

Branch protection

GitHub will prompt you that your main branch is not protected. It is recommended that a branch protection rule is setup for main to require pull requests.

Code Coverage

To ensure that code coverage is correctly uploaded to codecov.io follow Code Coverage.

Renovate

To ensure that your dependencies are kept up to date follow Renovate.

GitHub pages

If you configured the project to have docs then follow Building docs in CI.

PyPI uploading

If you configured the project to upload built wheels to PyPI then follow PyPI uploading.