Skip to content

Commit c1862bb

Browse files
authored
Update pull_request_template.md with new checks (#21127)
1 parent 67df30a commit c1862bb

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

.github/pull_request_template.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,23 @@ _Assess the level of risk and provide reasoning (e.g., scope, impact, backward c
1919

2020
---
2121

22+
### **Change Behind Feature Flag** (Yes / No)
23+
_Can this change be behine feature flag, if not why?_
24+
25+
---
26+
27+
### **Tech Design / Approach**
28+
- Design has been written and reviewed.
29+
- Any architectural decisions, trade-offs, and alternatives are captured.
30+
31+
---
32+
33+
### **Documentation Changes Required** (Yes/No)
34+
_Indicate whether related documentation needs to be updated._
35+
- User guides, API specs, system diagrams, or runbooks are updated.
36+
37+
---
38+
2239
### **Unit Tests Added or Updated** (Yes / No)
2340
_Indicate whether unit tests were added or modified to reflect these changes._
2441

@@ -29,8 +46,28 @@ _List all other tests performed (manual or automated, including integration, reg
2946

3047
---
3148

32-
### **Documentation Changes Required** (Yes / No)
33-
_Indicate whether related documentation needs to be updated._
49+
### **Logging Added/Updated** (Yes/No)
50+
- Appropriate log statements are added with meaningful messages.
51+
- Logging does not expose sensitive data.
52+
- Log levels are used correctly (e.g., info, warn, error).
53+
54+
---
55+
56+
### **Telemetry Added/Updated** (Yes/No)
57+
- Custom telemetry (e.g., counters, timers, error tracking) is added as needed.
58+
- Events are tagged with proper metadata for filtering and analysis.
59+
- Telemetry is validated in staging or test environments.
60+
61+
---
62+
63+
### **Rollback Scenario and Process** (Yes/No)
64+
- Rollback plan is documented.
65+
66+
---
67+
68+
### **Dependency Impact Assessed and Regression Tested** (Yes/No)
69+
- All impacted internal modules, APIs, services, and third-party libraries are analyzed.
70+
- Results are reviewed and confirmed to not break existing functionality.
3471

3572
---
3673

0 commit comments

Comments
 (0)