Skip to content

Commit a7771a3

Browse files
MuriloFPMuriloFP
authored
Fix/issue fixer pr template (#5839)
1 parent 2f4d833 commit a7771a3

File tree

1 file changed

+205
-0
lines changed

1 file changed

+205
-0
lines changed

‎.roo/rules-issue-fixer/9_pr_template.xml‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
<pr_template_instructions>
2+
<overview>
3+
This file contains the official Roo Code PR template that must be used when creating pull requests.
4+
All PRs must follow this exact format to ensure consistency and proper documentation.
5+
</overview>
6+
7+
<pr_body_template>
8+
<description>
9+
The PR body must follow this exact Roo Code PR template with all required sections.
10+
Replace placeholder content in square brackets with actual information.
11+
</description>
12+
<template><![CDATA[
13+
<!--
14+
Thank you for contributing to Roo Code!
15+
16+
Before submitting your PR, please ensure:
17+
- It's linked to an approved GitHub Issue.
18+
- You've reviewed our [Contributing Guidelines](../CONTRIBUTING.md).
19+
-->
20+
21+
### Related GitHub Issue
22+
23+
<!-- Every PR MUST be linked to an approved issue. -->
24+
25+
Closes: #[ISSUE_NUMBER] <!-- Replace with the issue number, e.g., Closes: #123 -->
26+
27+
### Roo Code Task Context (Optional)
28+
29+
<!--
30+
If you used Roo Code to help create this PR, you can share public task links here.
31+
This helps reviewers understand your development process and provides additional context.
32+
Example: https://app.roocode.com/share/task-id
33+
-->
34+
35+
[TASK_CONTEXT]
36+
37+
### Description
38+
39+
<!--
40+
Briefly summarize the changes in this PR and how they address the linked issue.
41+
The issue should cover the "what" and "why"; this section should focus on:
42+
- The "how": key implementation details, design choices, or trade-offs made.
43+
- Anything specific reviewers should pay attention to in this PR.
44+
-->
45+
46+
[DESCRIPTION_CONTENT]
47+
48+
### Test Procedure
49+
50+
<!--
51+
Detail the steps to test your changes. This helps reviewers verify your work.
52+
- How did you test this specific implementation? (e.g., unit tests, manual testing steps)
53+
- How can reviewers reproduce your tests or verify the fix/feature?
54+
- Include relevant testing environment details if applicable.
55+
-->
56+
57+
[TEST_PROCEDURE_CONTENT]
58+
59+
### Pre-Submission Checklist
60+
61+
<!-- Go through this checklist before marking your PR as ready for review. -->
62+
63+
- [x] **Issue Linked**: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
64+
- [x] **Scope**: My changes are focused on the linked issue (one major feature/fix per PR).
65+
- [x] **Self-Review**: I have performed a thorough self-review of my code.
66+
- [x] **Testing**: New and/or updated tests have been added to cover my changes (if applicable).
67+
- [x] **Documentation Impact**: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
68+
- [x] **Contribution Guidelines**: I have read and agree to the [Contributor Guidelines](/CONTRIBUTING.md).
69+
70+
### Screenshots / Videos
71+
72+
<!--
73+
For UI changes, please provide before-and-after screenshots or a short video of the *actual results*.
74+
This greatly helps in understanding the visual impact of your changes.
75+
-->
76+
77+
[SCREENSHOTS_CONTENT]
78+
79+
### Documentation Updates
80+
81+
<!--
82+
Does this PR necessitate updates to user-facing documentation?
83+
- [ ] No documentation updates are required.
84+
- [ ] Yes, documentation updates are required. (Please describe what needs to be updated or link to a PR in the docs repository).
85+
-->
86+
87+
[DOCUMENTATION_UPDATES_CONTENT]
88+
89+
### Additional Notes
90+
91+
<!-- Add any other context, questions, or information for reviewers here. -->
92+
93+
[ADDITIONAL_NOTES_CONTENT]
94+
95+
### Get in Touch
96+
97+
<!--
98+
Please provide your Discord username for reviewers or maintainers to reach you if they have questions about your PR
99+
-->
100+
101+
[DISCORD_USERNAME]
102+
]]></template>
103+
</pr_body_template>
104+
105+
<github_cli_commands>
106+
<description>
107+
Valid GitHub CLI commands for creating PRs with the proper template
108+
</description>
109+
110+
<create_pr_command>
111+
<description>Create a PR using the filled template</description>
112+
<command><![CDATA[
113+
gh pr create \
114+
--repo [owner]/[repo] \
115+
--base main \
116+
--title "[Type]: [Brief description] (#[issue-number])" \
117+
--body-file pr-body.md \
118+
--maintainer-can-modify
119+
]]></command>
120+
<note>The PR body should be saved to a temporary file first, then referenced with --body-file</note>
121+
</create_pr_command>
122+
123+
<create_pr_inline>
124+
<description>Alternative: Create PR with inline body (for shorter content)</description>
125+
<command><![CDATA[
126+
gh pr create \
127+
--repo [owner]/[repo] \
128+
--base main \
129+
--title "[Type]: [Brief description] (#[issue-number])" \
130+
--body "[Complete PR body content]" \
131+
--maintainer-can-modify
132+
]]></command>
133+
<note>Use this only if the body content doesn't contain special characters that need escaping</note>
134+
</create_pr_inline>
135+
136+
<fork_if_needed>
137+
<description>Fork repository if user doesn't have push access</description>
138+
<command><![CDATA[
139+
gh repo fork [owner]/[repo] --clone=false
140+
]]></command>
141+
<note>The --clone=false flag prevents cloning since we're already in the repo</note>
142+
</fork_if_needed>
143+
</github_cli_commands>
144+
145+
<pr_title_format>
146+
<description>PR titles should follow conventional commit format</description>
147+
<formats>
148+
<format type="bug_fix">fix: [brief description] (#[issue-number])</format>
149+
<format type="feature">feat: [brief description] (#[issue-number])</format>
150+
<format type="docs">docs: [brief description] (#[issue-number])</format>
151+
<format type="refactor">refactor: [brief description] (#[issue-number])</format>
152+
<format type="test">test: [brief description] (#[issue-number])</format>
153+
<format type="chore">chore: [brief description] (#[issue-number])</format>
154+
</formats>
155+
</pr_title_format>
156+
157+
<placeholder_guidance>
158+
<description>How to fill in the template placeholders</description>
159+
<placeholders>
160+
<placeholder name="ISSUE_NUMBER">
161+
<description>The GitHub issue number being addressed</description>
162+
<example>123</example>
163+
</placeholder>
164+
<placeholder name="TASK_CONTEXT">
165+
<description>Optional Roo Code task links if used during development</description>
166+
<example>https://app.roocode.com/share/task-abc123</example>
167+
<default>_No Roo Code task context for this PR_</default>
168+
</placeholder>
169+
<placeholder name="DESCRIPTION_CONTENT">
170+
<description>Detailed explanation of implementation approach</description>
171+
<guidance>
172+
- Focus on HOW you solved the problem
173+
- Mention key design decisions
174+
- Highlight any trade-offs made
175+
- Point out areas needing special review attention
176+
</guidance>
177+
</placeholder>
178+
<placeholder name="TEST_PROCEDURE_CONTENT">
179+
<description>Steps to verify the changes work correctly</description>
180+
<guidance>
181+
- List specific test commands run
182+
- Describe manual testing performed
183+
- Include steps for reviewers to reproduce tests
184+
- Mention test environment details if relevant
185+
</guidance>
186+
</placeholder>
187+
<placeholder name="SCREENSHOTS_CONTENT">
188+
<description>Visual evidence of changes for UI modifications</description>
189+
<default>_No UI changes in this PR_</default>
190+
</placeholder>
191+
<placeholder name="DOCUMENTATION_UPDATES_CONTENT">
192+
<description>Documentation impact assessment</description>
193+
<default>- [x] No documentation updates are required.</default>
194+
</placeholder>
195+
<placeholder name="ADDITIONAL_NOTES_CONTENT">
196+
<description>Any extra context for reviewers</description>
197+
<default>_No additional notes_</default>
198+
</placeholder>
199+
<placeholder name="DISCORD_USERNAME">
200+
<description>Discord username for communication</description>
201+
<example>@username</example>
202+
</placeholder>
203+
</placeholders>
204+
</placeholder_guidance>
205+
</pr_template_instructions>

0 commit comments

Comments
 (0)