-
Notifications
You must be signed in to change notification settings - Fork 4
Add templates for PR and Release #398
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+85
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| name: Release checklist | ||
| about: Ensure the project is ready to make a release. | ||
| title: Release Checklist v?.?.? | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| *This release checklist is intended to help keep to a consistent process for minor version releases.* | ||
| *The same process may be used for point releases, though usually with compressed timescales.* | ||
|
|
||
| *Minor version releases will generally be made from the `main` branch.* | ||
| *Bugfix releases may be made either from `main` or from a protected `v0.x` branch depending on whether there are significant changes already merged onto `main`.* | ||
|
|
||
| **Start of cycle** | ||
| - [ ] Create a milestone for the release. | ||
| - Add issues and pull requests to the release. | ||
|
|
||
| **Development** | ||
| - Open pull requests to close issues, prioritising those tagged for the next release. | ||
| - Periodically review priorities, usually with a subset of the OpenFlexure team. | ||
|
|
||
| **Release preparation** | ||
| - [ ] Decide on issues and PRs that will be included, adjusting milestones as necessary. | ||
| - [ ] Make a prerelease on PyPI for testing. | ||
|
|
||
| **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 in `pyproject.toml` | ||
| - [ ] 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. | ||
|
|
||
| **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. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| name: Pull request | ||
| about: Proposed changes to the software. | ||
| title: '' | ||
| labels: '' | ||
| assignees: '' | ||
| --- | ||
|
|
||
| **REPLACE ME** with a short summary of the context for this merge request. | ||
| <!-- Add summary of what this MR does above this comment --> | ||
|
|
||
| <!-- Closes #???--> | ||
| <!-- OFM-Feature-Branch: branchname --> | ||
|
|
||
|
rwb27 marked this conversation as resolved.
|
||
| ## This MR contains the following | ||
| * Bulleted | ||
| * Description of changes | ||
|
|
||
| <!-- uncomment if there are things to finish before merge | ||
| ## Before merge: | ||
|
|
||
| * [ ] Remaining thing 1 | ||
| * [ ] Remaining thing 2 | ||
| --> | ||
|
|
||
|
|
||
| ## Merge checklist: | ||
| <!-- Do not remove irrelevant checklist items.--> | ||
| <!-- Use ~strikeout~ to strike out not applicable questions, removing the [ ] so that the checklist count is correct.--> | ||
|
|
||
| * [ ] 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. | ||
|
rwb27 marked this conversation as resolved.
|
||
| * [ ] Any new or updated dependencies have been added to the project configuration (e.g., `pyproject.toml`). | ||
| * [ ] New functionality is fully tested. | ||
| * [ ] Any decrease in test coverage has been justified. | ||
| * [ ] Either the `test-against-ofm-v3` job passes, or `test-against-ofm-feature-branch` passes. | ||
| * [ ] New features have been used in a branch of the OpenFlexure Microscope, which is tested in `test-against-ofm-feature-branch`. | ||
| <!-- Note: uncomment the `OFM-Feature-Branch: branchname` line above to test against a feature branch in CI. --> | ||
| * [ ] This code has been tested manually against simulated hardware (detail tests in "Before merge"). | ||
| * [ ] This code has been tested against real hardware (detail tests in "Before merge"). | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.