.github: add a template for pull requests requesting testing info#32115
.github: add a template for pull requests requesting testing info#32115peterbarker wants to merge 1 commit intoArduPilot:masterfrom
Conversation
|
Please make “logs attached/available” a separate checkbox. Most PRs probably don’t have them and I think doing enough testing to check the box is still a good data point even if it’s not in the form of a bin log. It should always be acceptable to ask for logs though, and a good PR should of course make generating one easy! |
a9bfce0 to
c03a1b2
Compare
|
|
||
| <!-- Describe your changes here --> | ||
|
|
||
| ## Testing (your PR may be summarily closed without these) |
There was a problem hiding this comment.
| ## Testing (your PR may be summarily closed without these) | |
| ## Testing (your PR may be summarily closed without these) | |
| <!-- In addition to checking the box, describe the details --> |
There was a problem hiding this comment.
(IDK why I can't resolve this 😦 . Fine with me to not do it.)
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -0,0 +1,12 @@ | |||
| ## Description | |||
There was a problem hiding this comment.
Can we add a "## Summary" section, as a TLDR?
A 2-screen description can be a bit much at first sight.
There was a problem hiding this comment.
I've added something. I was tempted to have it be ## TLDR :-)
There was a problem hiding this comment.
[optional] Is it worth clarifying how the expected "one or two line summary" is distinct from the title? I expect that to already be a one-line summary.
Instead, perhaps the PR description should have info like:
- What goal(s) the PR accomplishes (if not obvious from the title).
- All github issue(s) it is resolving / related to.
- Other PRs it relates to (e.g. PR chain)
- Summarize the expected changes in behavior (if not obvious). The most common expected-statement is that the PR should not change user-facing behavior.
I like to incentivize PRs to be so small, single-purposed, and clear that the description could reasonably be "does what title says". (Of course that's omitted because it's tautological.) That's a mark of quality!
Just sharing my opinion from experience. No problem to ignore this feedback.
There was a problem hiding this comment.
Yeah, I really don't want this to get too complicated. Especially as this is really supposed to be a minimal you-have-tested-this,right? test.
Our issue template is more complicated and it's a pretty awful/repetitive process to create an issue a lot of the time.
c03a1b2 to
02f4f3d
Compare
02f4f3d to
344ad4c
Compare
No description provided.