{{ repository_name }}

Note: This file is expected to generate from template. See .github wiki for detailed instructions.

Templating checklists

• Replace {{ repository_name }} as placeholder text above with your repository name
• Initialize default labels with github-label-setup command
• Adjust CODEOWNERS
• Adjust release-type in release-please-config.json (default: python)
  • See more in documents of release-please
• Replace GH_USERNAME and GH_REPONAME in CONTRIBUTING.md
• Enable Allow GitHub Actions to create and approve pull requests as Workflow Permision in repository settings
  • release-please requires permission to raise PR with your repository and for this you need to update workflow permission in your repository settings
  • Refer to the capture below and enable GitHub Actions to raise PR to your repository

Then, you can clean texts above in this section and update with any of descriptions for your project! The following headers are skeletons of basic README.

Local Setup

Environmental variables, Makefile, docker-compose, ...etc

Good to know / Caveats

Anything if you have

License

Choose licenses for your project, see more details in GitHub Official Docs