Skip to content

Commit c35625d

Browse files
authored
Update pull_request_template.md with additional checks (#5259)
1 parent ebb2558 commit c35625d

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

.github/pull_request_template.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,44 @@ _Indicate whether unit tests were added or modified to reflect the changes._
2121

2222
### **Additional Testing Performed**
2323
_List manual or automated tests performed beyond unit tests (e.g., integration, scenario, regression)._
24+
25+
---
26+
27+
### **Change Behind Feature Flag** (Yes / No)
28+
_Can this change be behine feature flag, if not why?_
29+
30+
---
31+
32+
### **Tech Design / Approach**
33+
- Design has been written and reviewed.
34+
- Any architectural decisions, trade-offs, and alternatives are captured.
35+
36+
---
37+
38+
### **Documentation Changes Required** (Yes/No)
39+
_Indicate whether related documentation needs to be updated._
40+
- User guides, API specs, system diagrams, or runbooks are updated.
41+
42+
---
43+
### **Logging Added/Updated** (Yes/No)
44+
- Appropriate log statements are added with meaningful messages.
45+
- Logging does not expose sensitive data.
46+
- Log levels are used correctly (e.g., info, warn, error).
47+
48+
---
49+
50+
### **Telemetry Added/Updated** (Yes/No)
51+
- Custom telemetry (e.g., counters, timers, error tracking) is added as needed.
52+
- Events are tagged with proper metadata for filtering and analysis.
53+
- Telemetry is validated in staging or test environments.
54+
55+
---
56+
57+
### **Rollback Scenario and Process** (Yes/No)
58+
- Rollback plan is documented.
59+
60+
---
61+
62+
### **Dependency Impact Assessed and Regression Tested** (Yes/No)
63+
- All impacted internal modules, APIs, services, and third-party libraries are analyzed.
64+
- Results are reviewed and confirmed to not break existing functionality.

0 commit comments

Comments
 (0)