-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #806 from wellcomecollection/rk/pr-template
Update PULL_REQUEST_TEMPLATE.md
- Loading branch information
Showing
1 changed file
with
18 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,7 +1,22 @@ | ||
## Pull request checklist | ||
## What does this change? | ||
|
||
* Does this patch need a change to the documentation? | ||
<!-- A PR should have enough detail to be understandable far in the future. e.g what is the problem/why is the change needed, how does it solve it and any questions or points of discussion. --> | ||
|
||
Do you need to update the [Catalogue API Swagger][swagger]? | ||
### Checklist | ||
|
||
- [ ] Does this patch need a change to the documentation? | ||
- [ ] Do you need to update the [Catalogue API Swagger][swagger]? | ||
|
||
[swagger]: https://github.com/wellcomecollection/developers.wellcomecollection.org/blob/main/reference/catalogue.yaml | ||
|
||
## How to test | ||
|
||
<!-- Provide instructions to help others verify the change. This could take the form of "On PROD, do X and witness Y. On this branch, do X and witness Z. " --> | ||
|
||
## How can we measure success? | ||
|
||
<!-- Do you expect errors to decrease? Do you expect user journeys to be simplified? What can be used to prove this? A filtered view of logs or analytics, etc? --> | ||
|
||
## Have we considered potential risks? | ||
|
||
<!-- What are the potential risks and how can they be mitigated? Does an error require an alarm? --> |