chore: add section to note when all requirements are satisfied #2
Conversation
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
Or potentially modifying that based on your suggestion in Slack 😄 |
Hmmm... 🤔 Would we need both? I do like the idea of having a place to note what will be done in other PRs and what is taken care of in another repo's PR! That seems super helpful! |
dmitryshk
approved these changes
Apr 3, 2024
| **Are all of the original requirements satisfied in this PR?** <!-- ✍️ Yes/No --> | ||
|
|
||
| <!-- ✍️ | ||
| Sometimes it can be useful to break up a changeset to multiple PR, and sometimes changes in multiple repos are required |
There was a problem hiding this comment.
NIT: Good points but not quite regarding the PR description.
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.
Adds a section to the Pull Request template to call out when all original requirements are satisfied.
In some cases it can be useful to break up one Jira task into multiple pull requests to the same repo, and in other cases the requirements mean that changes are made to multiple repositories. In both cases it can sometimes be hard for a reviewer to understand whether a missing requirement is intentional or was simply missed.
The goal of this section is to facilitate better communication that the author, to the best of their knowledge, have either satisfied all the original requirements or they are aware and have a plan to address the remaining requirements before the issue is closed.