Skip to content

Commit 27ab626

Browse files
committed
improve and simplify pull request template
1 parent 2e5ccf5 commit 27ab626

File tree

1 file changed

+11
-42
lines changed

1 file changed

+11
-42
lines changed

docs/pull_request_template.md

Lines changed: 11 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,49 +19,18 @@
1919
- [ ] **Minor:** Small to medium changes, such as adding new functionality that is backward-compatible or minor refactoring. Moderate review needed.
2020
- [ ] **Patch:** Bug fixes, small tweaks, or documentation updates. Light review is sufficient.
2121

22-
#### **Testing & Validation:**
22+
## Test Coverage
23+
- [ ] Unit tests updated
24+
- [ ] Manual verification done
2325

24-
- [ ] **Unit Tests:** Added/updated to cover new logic or edge cases.
25-
- [ ] **Integration Tests:** Updated to verify interactions between components.
26-
- [ ] **E2E Tests:** Performed end-to-end testing in staging or development environment.
27-
- [ ] **Manual Testing:** The changes were manually tested and validated.
28-
- [ ] **No Regressions:** Verified that no existing functionality is broken.
26+
Evidence:
27+
<!-- commands, screenshots, GIFs if UI -->
2928

30-
### **Purpose:**
29+
## Impact / Risk
30+
<!-- subsystems touched, breaking potential -->
3131

32-
<!-- Describe the problem being solved and how the changes address it. -->
33-
<!-- Example: -->
34-
<!--
35-
This PR addresses an issue where the application fails to handle edge cases in the user profile update functionality. Specifically, the system was not correctly validating certain user input fields, leading to potential data corruption. The changes in this PR introduce more robust validation logic to ensure data integrity and prevent these errors.
36-
-->
32+
## Rollback
33+
<!-- git revert <sha> if needed or config toggle -->
3734

38-
### **Context:**
39-
40-
<!-- Provide relevant links to Jira issues, design documents, or previous discussions on Slack. -->
41-
<!-- Example: -->
42-
<!--
43-
- **Jira Issue:** [SKILLS-1000: User Profile Update Validation](https://jsw.ibm.com/browse/SKILLS-1000)
44-
- **Design Document:** [User Profile Validation Update](https://box.com)
45-
- **Previous Discussions:** [Slack Discussion on User Profile Validation](https://cognitive-app.slack.com/archives/C0765Q5FLR4/p1724076982965119)
46-
-->
47-
48-
### **Basic Usage:**
49-
50-
<!--
51-
Describe how this PR cause changes to the standard way users or developers interact with a part of the codebase.
52-
Mention if README (Users) or CONTRIBUTING (Dev) docs need to be updated to reflect these changes.
53-
-->
54-
<!-- Example: -->
55-
<!--
56-
No changes have been made to the basic usage of the user profile update functionality. The validation logic has been enhanced internally, but the API and user interface remain the same. The README and CONTRIBUTING documentation have been reviewed, and no updates are necessary as the changes are backward-compatible.
57-
-->
58-
59-
### **Notes to Reviewer:**
60-
61-
<!-- Use this section to provide important information to the reviewer. Highlight specific areas of the code where you would like the reviewer to focus their attention. -->
62-
<!-- Example: -->
63-
<!--
64-
- **Specific Areas to Focus:** Please pay close attention to the new validation logic in `UserProfileService.java`. This part of the code handles edge cases that could impact user data integrity. I'm particularly concerned about how it interacts with the existing data pipeline.
65-
- **Known Issues/Limitations:** Currently, the solution does not handle cases where the user input exceeds 500 characters. I'm aware of this limitation and plan to address it in a future PR.
66-
- **Requested Feedback:** Please provide feedback on the approach taken to refactor the `OrderProcessor` class. Specifically, let me know if you think the new design improves readability and maintainability compared to the previous implementation.
67-
-->
35+
## Reviewer Focus
36+
<!-- specific files or logic to inspect -->

0 commit comments

Comments
 (0)