Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/release_checklist.md
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.
Comment on lines +28 to +30

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [ ] Bump the version number.
- [ ] Bump the version number in `pyproject.toml`

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

41 changes: 41 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
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 -->

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

## 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`).

* [ ] 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").

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "labthings-fastapi"
version = "0.2.1"
version = "0.3.0-rc1"
authors = [
{ name="Richard Bowman", email="richard.bowman@cantab.net" },
]
Expand Down
Loading