- This package was generated from https://github.com/RallypointOne/JuliaPackageTemplate.jl
- Run tests:
julia --project -e 'using Pkg; Pkg.test()' - Build docs:
quarto render docs docs/has its own Project.toml for doc-specific dependencies.- Each .qmd file in the docs should have
engine: juliain the YAML frontmatter - Quarto YAML reference: https://quarto.org/docs/reference/
- Never edit Project.toml or Manifest.toml manually — use Pkg
api.qmdmust always be the last item before the "Reference" section in_quarto.ymlapi.qmdlives in its ownpart: "API"to visually separate it from other doc pages- The API page uses open cards (not collapsible blocks) to display exports
- 4-space indentation
- Docstrings on all exports
- Use
### Examplesfor inline docs examples - Segment code sections with: "#" * repeat('-', 80) * "# " * "$section_title"
- First released version should be v0.1.0
- Preflight: tests must pass and git status must be clean
- If current version has no git tag, release it as-is (don't bump)
- If current version is already tagged, bump based on commit log:
- Major: major rewrites (ask user if major bump is ok)
- Minor: new features, exports, or API additions
- Patch: fixes, docs, refactoring, dependency updates (default)
- Commit message:
bump version for new release: {x} to {y} - Generate release notes from commits since last tag (group by features, fixes, etc.)
- For major/minor bumps, release notes must include "breaking changes" section
- Update CHANGELOG.md with each release (prepend new entry under
# Unreleasedor version heading) - Register via:
gh api repos/{owner}/{repo}/commits/{sha}/comments -f body='@JuliaRegistrator register Release notes: <release notes here>'