|
1 | | -## Context |
| 1 | +<!-- |
| 2 | +Thank you for contributing to Roo Code! |
| 3 | +
|
| 4 | +Before submitting your PR, please ensure: |
| 5 | +- It's linked to an approved GitHub Issue. |
| 6 | +- You've reviewed our [Contributing Guidelines](../CONTRIBUTING.md). |
| 7 | +--> |
| 8 | + |
| 9 | +### Related GitHub Issue |
2 | 10 |
|
3 | | -<!-- Brief description of WHAT you’re doing and WHY. --> |
| 11 | +<!-- Every PR MUST be linked to an approved issue. --> |
4 | 12 |
|
5 | | -## Implementation |
| 13 | +Closes: # <!-- Replace with the issue number, e.g., Closes: #123 --> |
| 14 | + |
| 15 | +### Description |
6 | 16 |
|
7 | 17 | <!-- |
| 18 | +Briefly summarize the changes in this PR and how they address the linked issue. |
| 19 | +The issue should cover the "what" and "why"; this section should focus on: |
| 20 | +- The "how": key implementation details, design choices, or trade-offs made. |
| 21 | +- Anything specific reviewers should pay attention to in this PR. |
| 22 | +--> |
8 | 23 |
|
9 | | -Some description of HOW you achieved it. Perhaps give a high level description of the program flow. Did you need to refactor something? What tradeoffs did you take? Are there things in here which you’d particularly like people to pay close attention to? |
| 24 | +### Test Procedure |
10 | 25 |
|
| 26 | +<!-- |
| 27 | +Detail the steps to test your changes. This helps reviewers verify your work. |
| 28 | +- How did you test this specific implementation? (e.g., unit tests, manual testing steps) |
| 29 | +- How can reviewers reproduce your tests or verify the fix/feature? |
| 30 | +- Include relevant testing environment details if applicable. |
11 | 31 | --> |
12 | 32 |
|
13 | | -## Screenshots |
| 33 | +### Type of Change |
14 | 34 |
|
15 | | -| before | after | |
16 | | -| ------ | ----- | |
17 | | -| | | |
| 35 | +<!-- Mark all applicable boxes with an 'x'. --> |
18 | 36 |
|
19 | | -## How to Test |
| 37 | +- [ ] 🐛 **Bug Fix**: Non-breaking change that fixes an issue. |
| 38 | +- [ ] ✨ **New Feature**: Non-breaking change that adds functionality. |
| 39 | +- [ ] 💥 **Breaking Change**: Fix or feature that would cause existing functionality to not work as expected. |
| 40 | +- [ ] ♻️ **Refactor**: Code change that neither fixes a bug nor adds a feature. |
| 41 | +- [ ] 💅 **Style**: Changes that do not affect the meaning of the code (white-space, formatting, etc.). |
| 42 | +- [ ] 📚 **Documentation**: Updates to documentation files. |
| 43 | +- [ ] ⚙️ **Build/CI**: Changes to the build process or CI configuration. |
| 44 | +- [ ] 🧹 **Chore**: Other changes that don't modify `src` or test files. |
20 | 45 |
|
21 | | -<!-- |
| 46 | +### Pre-Submission Checklist |
| 47 | + |
| 48 | +<!-- Go through this checklist before marking your PR as ready for review. --> |
| 49 | + |
| 50 | +- [ ] **Issue Linked**: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above). |
| 51 | +- [ ] **Scope**: My changes are focused on the linked issue (one major feature/fix per PR). |
| 52 | +- [ ] **Self-Review**: I have performed a thorough self-review of my code. |
| 53 | +- [ ] **Code Quality**: |
| 54 | + - [ ] My code adheres to the project's style guidelines. |
| 55 | + - [ ] There are no new linting errors or warnings (`npm run lint`). |
| 56 | + - [ ] All debug code (e.g., `console.log`) has been removed. |
| 57 | +- [ ] **Testing**: |
| 58 | + - [ ] New and/or updated tests have been added to cover my changes. |
| 59 | + - [ ] All tests pass locally (`npm test`). |
| 60 | + - [ ] The application builds successfully with my changes. |
| 61 | +- [ ] **Branch Hygiene**: My branch is up-to-date (rebased) with the `main` branch. |
| 62 | +- [ ] **Documentation Impact**: I have considered if my changes require documentation updates (see "Documentation Updates" section below). |
| 63 | +- [ ] **Changeset**: A changeset has been created using `npm run changeset` if this PR includes user-facing changes or dependency updates. |
| 64 | +- [ ] **Contribution Guidelines**: I have read and agree to the [Contributor Guidelines](../CONTRIBUTING.md). |
22 | 65 |
|
23 | | -A straightforward scenario of how to test your changes will help reviewers that are not familiar with the part of the code that you are changing but want to see it in action. This section can include a description or step-by-step instructions of how to get to the state of v2 that your change affects. |
| 66 | +### Screenshots / Videos |
24 | 67 |
|
25 | | -A "How To Test" section can look something like this: |
| 68 | +<!-- |
| 69 | +For UI changes, please provide before-and-after screenshots or a short video of the *actual results*. |
| 70 | +This greatly helps in understanding the visual impact of your changes. |
| 71 | +--> |
26 | 72 |
|
27 | | -- Sign in with a user with tracks |
28 | | -- Activate `show_awesome_cat_gifs` feature (add `?feature.show_awesome_cat_gifs=1` to your URL) |
29 | | -- You should see a GIF with cats dancing |
| 73 | +### Documentation Updates |
30 | 74 |
|
| 75 | +<!-- |
| 76 | +Does this PR necessitate updates to user-facing documentation? |
| 77 | +- [ ] No documentation updates are required. |
| 78 | +- [ ] Yes, documentation updates are required. (Please describe what needs to be updated or link to a PR in the docs repository). |
31 | 79 | --> |
32 | 80 |
|
33 | | -## Get in Touch |
| 81 | +### Additional Notes |
34 | 82 |
|
35 | | -<!-- We'd love to have a way to chat with you about your changes if necessary. If you're in the [Roo Code Discord](https://discord.gg/roocode), please share your handle here. --> |
| 83 | +<!-- Add any other context, questions, or information for reviewers here. --> |
0 commit comments