this repository is made for template folder for developing julia project.
some of convenient features are available, but you need to fix to your current calculations.
- GitHub Repository Settings
- Actions Permissions: Go to
Settings > Actions > Generaland change Workflow permissions to "Read and write permissions". This is required forDocumenter.jl(docs) andTagBotto function. - Allow Auto-merge: (Recommended) Enable "Allow auto-merge" in
Settings > Generalto streamline the PR process.
- Actions Permissions: Go to
- Testing & Code Quality
- Codecov Setup:
- Register your repository at Codecov to obtain an upload token.
- Add the token to
Settings > Secrets and variables > Actionsas a repository secret namedCODECOV_TOKEN. - Replace the Codecov Badge link at the top of this README with the one provided in your Codecov dashboard.
- Codecov Setup:
- Documentation (Optional)
- Enable Workflow: Rename
.github/workflows/Documentation.yml.disabledto.github/workflows/Documentation.ymlto enable automatic document building. - GitHub Pages: After the first successful documentation build, go to
Settings > Pagesand set the source to thegh-pagesbranch.
- Enable Workflow: Rename
- Personalization
- LICENSE: Update the year and name in the
LICENSEfile. - Badges: Ensure all badge URLs at the top of this README point to your new repository path instead of the template.
- LICENSE: Update the year and name in the