Skip to content

Commit 33fccf6

Browse files
committed
docs: update .github/PULL_REQUEST_TEMPLATE.md via Apex Optimizer
1 parent 6a63d5e commit 33fccf6

File tree

1 file changed

+57
-22
lines changed

1 file changed

+57
-22
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 57 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,69 @@
11
# Pull Request Template
22

3-
**Important:** Please ensure your pull request adheres to the following guidelines before submitting.
3+
**Please provide a clear and concise description of your changes.**
44

5-
## 1. Pull Request Checklist
5+
---
66

7-
* [ ] I have read and understood the contributing guidelines.
8-
* [ ] My changes address a specific issue or feature documented in the project roadmap.
9-
* [ ] My code follows the project's coding standards and best practices.
10-
* [ ] I have added/updated relevant tests for my changes.
11-
* [ ] All new and existing tests pass.
12-
* [ ] I have updated the documentation (if applicable).
13-
* [ ] My changes do not introduce breaking changes or regressions.
14-
* [ ] I have provided a clear and concise description of my changes.
157

16-
## 2. Description of Changes
8+
## Type of Change
179

18-
<!-- Please provide a detailed explanation of the changes you are proposing. -->
19-
<!-- Include the problem statement, your solution, and any potential impacts. -->
20-
<!-- If this PR relates to an issue, please reference it using `closes #issue_number` or `fixes #issue_number`. -->
10+
* [ ] Bug fix (non-breaking change which fixes an issue)
11+
* [ ] New feature (non-breaking change which adds functionality)
12+
* [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
13+
* [ ] Refactoring (code style changes, reorganizing code, etc.)
14+
* [ ] Documentation Update
15+
* [ ] Performance Improvement
16+
* [ ] Other (please specify):
2117

22-
## 3. Architecture and Design
18+
---
2319

24-
<!-- Briefly describe any architectural or design considerations relevant to this PR. -->
25-
<!-- For significant changes, please refer to the `AGENTS.md` for architectural principles. -->
2620

27-
## 4. Testing
21+
## Description
2822

29-
<!-- Describe the testing strategy employed for these changes. -->
30-
<!-- This includes unit tests, integration tests, and any manual verification steps. -->
23+
[Provide a brief summary of the changes introduced in this pull request. What problem does it solve? What new functionality does it add?]
3124

32-
## 5. Related Issues
25+
---
3326

34-
<!-- Link to any related issues here. -->
27+
28+
## Motivation / Context
29+
30+
[Explain why these changes are necessary. Link to relevant issues or discussions if applicable.]
31+
32+
---
33+
34+
35+
## How Has This Been Tested?
36+
37+
* [ ] Unit Tests (via Pytest)
38+
* [ ] Integration Tests
39+
* [ ] Manual Testing
40+
* [ ] No tests needed (please explain why)
41+
42+
[Describe the tests you ran to verify your changes. Provide instructions on how to reproduce them.]
43+
44+
---
45+
46+
47+
## Checklist
48+
49+
* [ ] My code follows the code style of this project.
50+
* [ ] I have performed a self-review of my own code.
51+
* [ ] I have commented my code, particularly in hard-to-understand areas.
52+
* [ ] I have made corresponding changes to the documentation (if applicable).
53+
* [ ] My changes generate no new warnings or errors.
54+
* [ ] I have updated unit tests that prove my fix is effective or that my feature works.
55+
* [ ] Any dependent changes have been merged and published.
56+
57+
---
58+
59+
60+
## Related Issues
61+
62+
[Link to any issues that this pull request resolves or relates to, e.g., `Closes #123`]
63+
64+
---
65+
66+
67+
## Developer Notes
68+
69+
[Add any additional information that may be helpful to the reviewer. This could include screenshots, specific areas to focus on, or known limitations.]

0 commit comments

Comments
 (0)