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

If the repository is in the DiamondLightSource org, then follow the dev guide to see the recommended settings.

Code Coverage#

To ensure that code coverage is correctly uploaded to codecov.io follow Installing Codecov GitHub app

Renovate#

To ensure that your dependencies are kept up to date follow Use renovate to keep dependencies up to date

GitHub pages#

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

PyPI uploading#

If you configured the project to upload built wheels to PyPI then follow Setting up PyPI publishing