README.md.jinja

# {{ project_name }}


# TO DO AFTER COPYING A TEMPLATE
1. Settings -> Code and automation -> Actions -> General: 
    - Workflow permissions:
        - Select **Read and write permissions**
        - Tick **Allow GitHub Actions to create and approve pull requests**
        - Press Save.
2. Settings -> Security -> Secrets and variables -> Actions:
    - Add PyPI token (in BitWarden)
3. Settings -> Security -> Code security and analysis:
    - Enable Private vulnerabilities alert
    - Enable Dependabot stuff (all)
    - Select basic CodeQL analysis 
    - Enable Secret scanning
4. After successful publish docs build will have `gh-pages` branch. Go to Settings -> Code and automation -> Pages -> Branch: `gh-pages` and Save.
5. Codecov: go to Codecov website and set this repo to be included. Then add the token given to the secrets (as in step 2).
6. Make branch protection rule in Code and automation -> Branches -> Add rule:
    - Branch name pattern: `main`
    - Require a pull request before merging
        - Require approvals
    - Require status checks to pass before merging
        - Require branches to be up to date
    - Allow force pushes
        - Specify who can force push: atropos

6. Clean up:
    - Remove the silly example test.
    - Remove this readme content and replace with project specific content.
    - Press about kog and select **Use your GitHub Pages website**.