Repository navigation
Fold "How to test" into "How was this tested?" - #448
Merged
Merged
Conversation
The two sections asked for much the same thing in most PRs.
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The PR-writing guidance in AGENTS.md still references the removed “How to test” section and needs to align with “How was this tested?” and its requirement for results and repeatable steps.
1 open issue
What changed in this PR
Simplifies the repository’s pull request template by merging testing instructions and results into one section, as part of the wider template update.
Changes:
- Removes the separate “How to test” section.
- Expands “How was this tested?” to request results and enough detail to repeat checks.
- Directs production-only checks to “How will we check it after deploy?”.
| File | Description |
|---|---|
.github/pull_request_template.md |
Consolidates testing guidance and clarifies where production-only checks belong. |
Review effort: Balanced
| ## How was this tested? | ||
|
|
||
| <!-- What you ran and where, with links. For a routine change, passing CI and a sentence on what you checked locally or in stage is enough. --> | ||
| <!-- What you ran and where, what you saw, and links, so a reviewer can repeat it. For a routine change, passing CI and a sentence on what you checked locally or in stage is enough. Anything that can only be checked in production goes under "How will we check it after deploy?". --> |
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
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.

For wellcomecollection/platform#6874.
What does this change?
Folds "How to test" into "How was this tested?" in the pull request template. Review on wellcomecollection/catalogue-pipeline#3909 pointed out that the two sections repeat each other in most PRs. The merged section asks what was run and what it showed, with enough for a reviewer to repeat it, and sends production-only checks to "How will we check it after deploy?". The org template and every repository override get the same change.
How was this tested?
Template text only; read the rendered template on the branch.
Have we considered potential risks?
None beyond wording. Open PRs keep the bodies they were written with.
How will we check it after deploy?
The next PR opened here shows one testing section.
How do we roll it back?
Revert this PR.