Skip to content

Commit 423defe

Browse files
committed
add a release checklist to contrib guide
1 parent 269529b commit 423defe

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

contribute.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,13 @@ Some informative text about your example
127127
`````
128128

129129
Other useful admonitions (e.g., `hint`, `note`) can be found [here](https://mystmd.org/guide/directives).
130+
131+
## Release process checklist
132+
133+
Before creating a release, please make sure to go through the following items to make sure the release is complete and consistent.
134+
135+
- [ ] Update `_version.py`. Some internal code requires a version number to be provided there to auto-generate some parts of the documentation.
136+
- [ ] Update versions in examples. Go through the examples in the `examples/` and make sure that all version numbers in the `.json` files are up-to-date.
137+
- [ ] Update the specification number in the spec text. The [spec text](ngff-spec:spec) mentions its own version number in several places. Please make sure to update those to the new version.
138+
- [ ] Make sure all tests are passing. Run the test suite to make sure that all tests are passing before creating a release.
139+
- [ ] Update the version history. Add a new entry to the [version history](ngff-spec:history) file with the new version number and date, and a summary of the changes made in this release.

index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(ngff-spec:spec)=
12
---
23
title: Next-generation file format specification
34
short_title: OME-Zarr

version_history.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
author: ""
33
---
44
# Version History
5-
(history)=
5+
(ngff-spec:history)=
66

77
All notable changes to this project will be documented in this file.
88

0 commit comments

Comments
 (0)