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.
Link to issue number:
None
Summary of the issue:
Revert PRs are janitorial actions which do not make sense to follow the PR template.
Typically these are made adhoc using the GitHub UX.
When performing a revert, it is important to note issues being opened and closed by the reversion.
It is also vital to note the PR being reverted.
Adding a short reason for reversion will help people understand a summary of what is going on.
Description of user facing changes
None
Description of development approach
Created a new template to be copy-pasted when performing a revert
Testing strategy:
N/A
Known issues with pull request:
GitHub has a suggested UX for multiple PR templates: https://github.blog/2018-01-25-multiple-issue-and-pull-request-templates/
The GitHub UX for having multiple PR templates is less than ideal.
It's like landing at https://github.com/nvaccess/nvda/issues/new rather than https://github.com/nvaccess/nvda/issues/new/choose.
I figure this process may annoy some contributors.
Additionally, when performing a revert through GitHubs UX, the PR template is automatically overriden anyway, meaning the UX for multiple PR templates is bypassed anyway.
I've opened a feature request here to improve this design: https://github.com/orgs/community/discussions/121757
Code Review Checklist: