repo-template

This repository contains common settings and actions that I tend to use in my demos and projects.

Setup

NOTE: TODOs are sprinkled in the files and can be used to find where changes may be necessary.

1. Use as a template when creating a new GitHub repo, or copy the contents into a bare-repo directory.
2. Update .pre-commit-config.yml to add/remove plugins as necessary.
3. Modify README.md and CONTRIBUTING.md, change LICENSE as needed.
4. Review GitHub PR and issue templates.
5. If using release-please action, make these changes:
   1. In GitHub Settings:
      • Settings > Actions > General > Allow GitHub Actions to create and approve pull requests is checked
      • Settings > Secrets and Variables > Actions, and add RELEASE_PLEASE_TOKEN with PAT as a Repository Secret
   2. Modify release-please action to have the correct release-type and enable
   3. Reset version.txt to an empty file or remove if using a different release-please type.
6. Remove all CHANGELOG entries.
7. Commit changes.