Skip to content

Fold "How to test" into "How was this tested?" - #448

Merged
kenoir merged 1 commit into
mainfrom
rk-6874-fold-testing
Nov 16, 2026
Merged

kenoir merged 1 commit into
mainfrom
rk-6874-fold-testing

Conversation

@kenoir

@kenoir kenoir commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

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.

The two sections asked for much the same thing in most PRs.
@kenoir
kenoir requested a review from a team as a code owner November 16, 2026 16:15
Copilot AI balanced review requested due to automatic review settings November 16, 2026 16:15

Copilot AI left a comment

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.

🟡 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?". -->
@kenoir
kenoir merged commit 975e220 into main Nov 16, 2026
9 checks passed
@kenoir
kenoir deleted the rk-6874-fold-testing branch November 16, 2026 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants