Note: This file is expected to generate from template. See .github wiki for detailed instructions.
- Replace
{{ repository_name }}as placeholder text above with your repository name - Initialize repository configs with
repoostercommand - Initialize default labels with
github-label-setupcommand - Update
release-typein.github/config/release-please-config.json(default:simple)- See more in documents of release-please
- Validate repository access of semantic-prs GitHub Apps, whose configurations exists
.github/semantic.yml - Validate
Allow GitHub Actions to create and approve pull requestsas 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
- Add
LICENSEfile to your project- See more details in GitHub Official Docs
- Replace
GH_USERNAMEandGH_REPONAMEin CONTRIBUTING.md - Adjust
.github/CODEOWNERS- See its syntax in GitHub Official Docs
- Adjust in CITATION.cff
- See more details about Citation File Format in GitHub documents and official 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.
Makefile, docker-compose, ...etc
Environmental Variables, ...etc
Anything if you have