Skip to content

.github: add a template for pull requests requesting testing info#32115

Open
peterbarker wants to merge 1 commit intoArduPilot:masterfrom
peterbarker:pr-claude/pr-template
Open

.github: add a template for pull requests requesting testing info#32115
peterbarker wants to merge 1 commit intoArduPilot:masterfrom
peterbarker:pr-claude/pr-template

Conversation

@peterbarker
Copy link
Contributor

No description provided.

@tpwrules
Copy link
Contributor

tpwrules commented Feb 6, 2026

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!

@peterbarker peterbarker force-pushed the pr-claude/pr-template branch from a9bfce0 to c03a1b2 Compare February 6, 2026 01:25

<!-- Describe your changes here -->

## Testing (your PR may be summarily closed without these)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 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 -->

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(IDK why I can't resolve this 😦 . Fine with me to not do it.)

@@ -0,0 +1,12 @@
## Description
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a "## Summary" section, as a TLDR?

A 2-screen description can be a bit much at first sight.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added something. I was tempted to have it be ## TLDR :-)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@peterbarker peterbarker force-pushed the pr-claude/pr-template branch from c03a1b2 to 02f4f3d Compare February 6, 2026 09:58
@peterbarker peterbarker force-pushed the pr-claude/pr-template branch from 02f4f3d to 344ad4c Compare February 6, 2026 20:53
@Hwurzburg Hwurzburg self-requested a review February 6, 2026 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ReadyForDevCall

Development

Successfully merging this pull request may close these issues.

6 participants