Suggestions to hopefully improve PR checklist #2
There are no files selected for viewing
This file contains hidden or 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,14 +1,23 @@ | ||
| **References** <!-- Link to the Jira task --> | ||
| PROJ-XXX | ||
|
|
||
| ### Type of change | ||
| - [ ] Bug fix <!-- non-breaking change which fixes an issue --> | ||
| - [ ] New feature <!-- non-breaking change which adds functionality --> | ||
| - [ ] Breaking change <!-- fix or feature that would cause existing functionality to not work as expected --> | ||
|
|
||
| ### Description of the change with screenshots (if possible) | ||
| <!-- Describe here what changed with this PR --> | ||
|
|
||
| ### Validation steps | ||
| <!-- Instructions for QA --> | ||
|
|
||
| ### Pull request checklist | ||
| - [ ] Can it be deployed automatically? <!-- If manual actions are required, fill in the deploy steps below --> | ||
|
Contributor
There was a problem hiding this comment. I'm not sure I agree with moving it to a comment like this. I don't know how other people use this, but personally I use the checklist to click the different checkboxes when it's in rendered mode. In this mode, the comments does not appear, and then I would not be reminded about filling it out. What do you think? |
||
| - [ ] My code follows the style guidelines of this project. | ||
|
Contributor
There was a problem hiding this comment. I don't think that should be part of the checklist. That should be completely automatic and part of CI |
||
| - [ ] I have performed a self-review of my code. | ||
| - [ ] This change requires a documentation update and I have updated the documentation. | ||
|
Contributor
There was a problem hiding this comment. Maybe, if we want to keep it as a checklist, we can do something like |
||
| - [ ] This change requires a translation update and I have updated the translations. | ||
|
Contributor
There was a problem hiding this comment. Maybe same here? |
||
| - [ ] Did you update sanitization routines, where personal information is handled? <!-- Delete if not applicable --> | ||
|
|
||
| ### Deploy steps <!-- Delete this if the deploy is automatic --> | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I especially like this change. Nice 👌