Release checklist
SigMap uses:
feature branches → develop → mainBefore merging contributor PRs into develop
- [ ] PR targets
develop - [ ] CI passes
- [ ] Tests are included if needed
- [ ] Docs are updated if needed
- [ ]
CHANGELOG.mdhas a contributor credit line - [ ] Benchmark claims are not changed without benchmark data
Before merging develop into main
- [ ] All planned PRs are merged into
develop - [ ] CI passes on
develop - [ ] Docs build passes
- [ ] Benchmarks are run if needed
- [ ] README is updated
- [ ]
CHANGELOG.mdis finalized - [ ] Contributor names are included
- [ ] Release notes are drafted
Release PR format
develop → mainThe release PR should include:
- summary
- included PRs
- contributors
- test results
- benchmark notes
- release notes draft
After merge to main
- [ ] Create GitHub release
- [ ] Publish release notes
- [ ] Thank contributors
- [ ] Share update if relevant