Reorganize and update PR template #5106
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #5106 +/- ##
=======================================
Coverage 99.97% 99.97%
=======================================
Files 86 86
Lines 3508 3508
=======================================
Hits 3507 3507
Misses 1 1Continue to review full report at Codecov.
|
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| If adding a **new feature**, the PR's description includes: | ||
| - [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it) | ||
|
|
||
| If fixing a **bug**, the PR's description includes: |
There was a problem hiding this comment.
I find this quite cumbersome if the issue is already opened with all these details. Isn't the When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number enough?
There was a problem hiding this comment.
What if we changed these two sub-headings to, "the PR's description or a linked to issue includes"?
There was a problem hiding this comment.
I think that we should remove the whole block. I'm worried about the list being too long and scary for new contributors. Do we have PRs that try to fix bugs that doesn't exist?
There was a problem hiding this comment.
You look at PRs on this repo more than I do, so if it's not solving a problem you commonly see, I agree it does make sense to remove it.
Using the updated PR template below - so meta!
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
Other information: