-
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,35 @@ | ||||||||||||||
| --- | ||||||||||||||
| 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. | ||||||||||||||
|
|
||||||||||||||
| **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. | ||||||||||||||
|
|
||||||||||||||
| **Release** | ||||||||||||||
| - [ ] Bump the version number. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
It's good to be specific in these checklists |
||||||||||||||
| - [ ] 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,41 @@ | ||||||||||
| --- | ||||||||||
| 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 --> | ||||||||||
|
|
||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| ## 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. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| * [ ] 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"). | ||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.