Conversation
The pull request template is a bit confusing and is prone to creating extra noise. * After the line "PR Title", the reader is instructed to fill out a description of changes, and then there is the line "Description". If "PR Title" and "Description" are section headers, one would think a description would be placed within the "Description" section, not the "PR Title" section. * The "Description" section holds an example, but most PRs I've seen do not clear this section out appropriately, but leave unfilled sections untouched. * This PR template is inconsistent with the one we use for the module template. While of course this repo is shared among multiple teams, we should strive to keep it somewhat more consistent.
Gudahtt
approved these changes
Apr 3, 2023
Member
Gudahtt
left a comment
Gudahtt
left a comment
There was a problem hiding this comment.
LGTM! Thanks for updating this, I've been meaning to do this for some time
Contributor
|
looks good. Just wondering if we should put this in the module template ? |
BelfordZ
approved these changes
Apr 5, 2023
Contributor
Author
|
@BelfordZ Yeah, that'd probably be good. I'll make a PR over there too. |
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
The pull request template is a bit confusing and is prone to creating extra noise. * After the line "PR Title", the reader is instructed to fill out a description of changes, and then there is the line "Description". If "PR Title" and "Description" are section headers, one would think a description would be placed within the "Description" section, not the "PR Title" section. * The "Description" section holds an example, but most PRs I've seen do not clear this section out appropriately, but leave unfilled sections untouched. * This PR template is inconsistent with the one we use for the module template. While of course this repo is shared among multiple teams, we should strive to keep it somewhat more consistent.
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
The pull request template is a bit confusing and is prone to creating extra noise. * After the line "PR Title", the reader is instructed to fill out a description of changes, and then there is the line "Description". If "PR Title" and "Description" are section headers, one would think a description would be placed within the "Description" section, not the "PR Title" section. * The "Description" section holds an example, but most PRs I've seen do not clear this section out appropriately, but leave unfilled sections untouched. * This PR template is inconsistent with the one we use for the module template. While of course this repo is shared among multiple teams, we should strive to keep it somewhat more consistent.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
The pull request template is a bit confusing and is prone to creating extra noise.
Changes
Checklist