Skip to content

Commit 19fa33d

Browse files
authored
Add. PR Template
1 parent 27024ff commit 19fa33d

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

.github/pull_request_template.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
> [!NOTE]
2+
> Thank you for your contribution. Please find the details of this pull request below.
3+
4+
**JIRA**[BN-#](https://bahmni.atlassian.net/browse/BN-#)
5+
6+
### **Description**
7+
8+
<!--- Provide a concise and informative summary of the PR. Briefly describe what functionality is being introduced, modified, or fixed, and the broader context or objective behind it. -->
9+
10+
---
11+
12+
### **Key Features**
13+
<!--- Summarize each major feature added or enhanced. -->
14+
<!--- State user-facing or workflow-impacting changes. -->
15+
<!--- Mention any significant UX, UI, or accessibility improvements. -->
16+
17+
---
18+
19+
### **Implementation Details**
20+
21+
* **UI Components**
22+
<!--- Briefly explain any new or updated UI components. Mention if they are added to Storybook. -->
23+
<!--- Describe any UX flows introduced or updated. -->
24+
25+
* **State Management**
26+
<!--- Mention any local/global state changes, if applicable. -->
27+
28+
* **Custom Hooks**
29+
<!--- Mention any new custom hooks added, if applicable. -->
30+
31+
* **API Integration**
32+
<!--- List API endpoints integrated or modified. -->
33+
<!--- Note any request/response mapping changes or error handling updates. -->
34+
35+
* **Performance & Optimization**
36+
<!--- Outline any performance-related enhancements, such as debouncing, lazy loading, etc. -->
37+
38+
* **Internationalisation**
39+
<!--- Mention if locale dictionary updates or label translations were added. -->
40+
41+
* **Accessibility**
42+
<!--- State any WCAG compliance or keyboard navigation improvements, if applicable. -->
43+
44+
* **Limitations**
45+
<!--- Call out any known limitations or areas deferred to future stories. -->
46+
47+
---
48+
49+
### **Testing & Type Definitions**
50+
51+
* **Unit Tests**
52+
<!--- Indicate coverage for core logic, component rendering, and edge cases. -->
53+
54+
* **Integration Tests**
55+
<!--- Highlight any full-flow tests, especially for user interaction and state updates. -->
56+
57+
* **Type Definitions**
58+
<!--- Mention any new or updated TypeScript types or interfaces. -->
59+
<!--- Confirm type safety and strict mode adherence. -->
60+
61+
---
62+
63+
### **Screenshots**
64+
65+
| Feature / State | Screenshot |
66+
|------------------|------------|
67+
| Example: Empty State | Attach image or paste screenshot here |
68+
| Example: Search Result | Attach image or paste screenshot here |
69+
| Example: Validation Error | Attach image or paste screenshot here |
70+
71+
_Note: Please ensure sensitive information is not included in screenshots._
72+
73+
---
74+
75+
### **Next Steps**
76+
<!--- Describe follow-up stories, technical enhancements, or integration tasks. -->
77+
<!--- Mention any coordination required with backend or product teams. -->
78+
79+
---
80+
81+
> [!IMPORTANT]
82+
> **Checklist**
83+
>
84+
> - [ ] Code adheres to project linting and formatting standards.
85+
> - [ ] New components added to Storybook.
86+
> - [ ] Tests written and passing (unit + integration).
87+
> - [ ] Labels and text support i18n.
88+
> - [ ] Follows accessibility and responsive design guidelines.
89+
> - [ ] PR reviewed by at least one other developer.
90+
91+
---
92+
93+
### **Reviewer(s)**
94+
95+
@bahnew/developers
96+
_Kindly review the proposed changes when convenient. Your feedback is appreciated._
97+
98+
---

0 commit comments

Comments
 (0)