Add templates for PR and Release - #398
Open
rwb27 wants to merge 2 commits into
Open
Conversation
Barecheck - Code coverage reportTotal: 97.43%Your code coverage diff: 0.00% ▴ ✅ All code changes are covered |
rwb27
force-pushed
the
release-checklist
branch
from
August 6, 2026 11:26
7b8045d to
679bf6c
Compare
bprobert97
reviewed
Aug 7, 2026
| - [ ] Open issues and PRs to fix any bugs that are found. | ||
|
|
||
| **Release** | ||
| - [ ] Bump the version number. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [ ] Bump the version number. | |
| - [ ] Bump the version number in `pyproject.toml` |
It's good to be specific in these checklists
Comment on lines
+28
to
+30
| **Manual testing** | ||
| - [ ] Ensure the prerelease is tested against a real system (currently this will be an OpenFlexure Microscope). | ||
| - [ ] Open issues and PRs to fix any bugs that are found. |
Contributor
There was a problem hiding this comment.
Suggested change
| **Manual testing** | |
| - [ ] Ensure the prerelease is tested against a real system (currently this will be an OpenFlexure Microscope). | |
| - [ ] Open issues and PRs to fix any bugs that are found. | |
| **Testing** | |
| - [ ] Check that all formatting, linting, unit, and integration tests are passing on CI | |
| - [ ] Verify core functionality against a real system: | |
| - [ ] Run a large ( > 200 images) slide scan on an OpenFlexure Microscope | |
| - [ ] Verify the UI on the OpenFlexure Microscope works as expected | |
| - [ ] Report any relevant bugs as an Issue in the [OpenFlexure Microscope Server Repository](https://gitlab.com/openflexure/openflexure-microscope-server) | |
| - [ ] Open issues and PRs in the labthings-fastapi to fix any bugs that are found in the labthings software. |
| **Release** | ||
| - [ ] Bump the version number. | ||
| - [ ] Make a release on Github, including a changelog in the release notes. | ||
| - [ ] Verify that the release appears on PyPI and add a link to the Github release. |
Contributor
There was a problem hiding this comment.
Suggested change
| - [ ] Verify that the release appears on PyPI and add a link to the Github release. | |
| - [ ] Verify that the release appears on PyPI and add a link to the Github release. | |
| **Post-Release** | |
| - [ ] Announce the new release on relevant channels, including telling the OpenFlexure Core Team and other other downstream project teams. | |
| - [ ] Close this issue and the corresponding GitHub Milestone. |
|
|
||
| <!-- Closes #???--> | ||
| <!-- OFM-Feature-Branch: branchname --> | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| > **Note for external contributors:** Please ensure this PR is submitted from a fork of the repository. Direct branch creation is restricted to core maintainers. | |
|
|
||
| * [ ] All new/changed functions have up to date typehints and docstrings. | ||
| * [ ] Any changes to the public API have been updated in `docs/src/public_api.rst`. | ||
| * [ ] New or changed features have been added to (or updated in) the conceptual documentation. |
Contributor
There was a problem hiding this comment.
Suggested change
| * [ ] New or changed features have been added to (or updated in) the conceptual documentation. | |
| * [ ] New or changed features have been added to (or updated in) the conceptual documentation. | |
| * [ ] Any new or updated dependencies have been added to the project configuration (e.g., `pyproject.toml`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a release checklist and a merge checklist.
Closes #309