You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contribute.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,3 +127,13 @@ Some informative text about your example
127
127
`````
128
128
129
129
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.
0 commit comments