Skip to content

docs: PR template update with assurance guidance #1836

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.

Sign up for GitHub

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

Closed
rfk-nc wants to merge 2 commits into from
Closed

docs: PR template update with assurance guidance #1836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6249b2
PR template update with assurance guidance
rfk-nc Feb 11, 2026
88d74c7
Amend linting allowed abbreviations to include UI
rfk-nc Feb 11, 2026
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
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@

<!-- Why is this change required? What problem does it solve? -->

## Assurances

### Clinical assurance-friendly description of the change
Copy link
Contributor

@stephhou stephhou Feb 11, 2026

Choose a reason for hiding this comment

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

Are we better off makng one description and ensuring it's readable for all audiences?


<!-- A description of the change that is suitable for a clinical audience -->
Copy link
Contributor

@stephhou stephhou Feb 11, 2026

Choose a reason for hiding this comment

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

Is there an example of what this type of description is?


### Test Evidence to support the change

- [ ] Unit tests (screenshot of test results or link to test results)
- [ ] End2End tests (screenshot of test results or link to test results)
- [ ] UI before/after screenshots
- [ ] Other manual testing (description of manual testing performed and results)

### Risks associated with the change
Copy link
Contributor

@stephhou stephhou Feb 11, 2026

Choose a reason for hiding this comment

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

Are these risks that are logged in Jira?


<!-- A description of the risks associated with the change -->

### Mittigations to the risks associated with the change
Copy link
Contributor

@stephhou stephhou Feb 11, 2026

Choose a reason for hiding this comment

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

sp


<!-- A description of the mitigations to the risks associated with the change -->

## Type of changes

<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
Expand Down
1 change: 1 addition & 0 deletions scripts/config/vale/styles/Vocab/words/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ npm
cmd
ctrl
ui
UI
Entra
Loading