Update pr template #1605
Update pr template #1605
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the pull request template to provide more structured guidance for contributors, particularly for agents like Copilot. The new template replaces generic contribution guidelines with specific sections covering purpose, changes, MCP tool impact, security considerations, testing requirements, and documentation.
Key changes:
- Restructured template with explicit sections (Summary, Why, What changed, MCP impact, Security/limits, Lint & tests, Docs)
- Added checkboxes for common scenarios with prompts for brief explanations
- Included instructions for Copilot to encourage concise, concrete answers
| ## Summary | ||
| <!-- In 1–2 sentences: what does this PR do? --> | ||
|
|
||
| ## Why |
There was a problem hiding this comment.
Can we add a section asking to add prompts tested for triggering the tool (tool changes only)
I think we really want to understand what they want to achieve, not just their solution so that if we disagree with the solution we can still consider the problem they are hoping to solve and consider how we would solve it.
Collecting use-case would be high value for product.
There was a problem hiding this comment.
Good, point! @copilot add a section asking to add prompts tested for triggering the tool (only for tool changes).
|
@JoannaaKL I've opened a new pull request, #1617, to work on those changes. Once the pull request is ready, I'll request review from you. |
* Initial plan * Add prompts tested section to PR template for tool changes Co-authored-by: JoannaaKL <67866556+JoannaaKL@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: JoannaaKL <67866556+JoannaaKL@users.noreply.github.com>
Fill
pull_request_template.mdwith more hints for agents.