Skip to content

Commit 1ff9ed8

Browse files
BenzillaBen Stokes
andauthored
docs: simplify PR template (#4)
Co-authored-by: Ben Stokes <benstokes@MacBook-Air.local>
1 parent 6903c69 commit 1ff9ed8

1 file changed

Lines changed: 12 additions & 59 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,28 @@
11
## Description
22

3-
<!-- Describe your changes in detail -->
4-
5-
## Related Issue
6-
7-
<!-- Link to the issue this PR addresses -->
8-
9-
Fixes #(issue number)
3+
<!-- What does this PR do and why? -->
104

115
## Type of Change
126

13-
<!-- Mark the relevant option with an "x" -->
14-
15-
- [ ] Bug fix (non-breaking change that fixes an issue)
16-
- [ ] New feature (non-breaking change that adds functionality)
17-
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
18-
- [ ] Documentation update
19-
- [ ] Refactoring (no functional changes)
20-
- [ ] Performance improvement
21-
- [ ] Test update
22-
23-
## How Has This Been Tested?
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Breaking change
10+
- [ ] Refactoring
11+
- [ ] Documentation
2412

25-
<!-- Describe the tests you ran to verify your changes -->
13+
## How Was This Tested?
2614

2715
- [ ] Unit tests
2816
- [ ] Integration tests
2917
- [ ] Manual testing
3018

31-
**Test Configuration:**
32-
33-
- Node.js version:
34-
- OS:
19+
<!-- Brief description of what you tested -->
3520

3621
## Screenshots (if applicable)
3722

38-
<!-- Add screenshots to help explain your changes -->
39-
4023
## Checklist
4124

42-
<!-- Mark completed items with an "x" -->
43-
44-
- [ ] My code follows the project's style guidelines
45-
- [ ] I have performed a self-review of my own code
46-
- [ ] I have commented my code, particularly in hard-to-understand areas
47-
- [ ] I have made corresponding changes to the documentation
48-
- [ ] My changes generate no new warnings
49-
- [ ] I have added tests that prove my fix is effective or that my feature works
50-
- [ ] New and existing unit tests pass locally with my changes
51-
- [ ] Any dependent changes have been merged and published
52-
53-
## API Changes (if applicable)
54-
55-
<!-- Document any API changes -->
56-
57-
**New Endpoints:**
58-
59-
```
60-
POST /v1/example
61-
```
62-
63-
**Modified Endpoints:**
64-
65-
```
66-
GET /v1/example (added new query parameter)
67-
```
68-
69-
**Breaking Changes:**
70-
71-
<!-- List any breaking changes and migration steps -->
72-
73-
## Additional Notes
74-
75-
<!-- Add any additional context or notes for reviewers -->
25+
- [ ] Self-reviewed my code
26+
- [ ] No new warnings
27+
- [ ] Existing tests still pass
28+
- [ ] Breaking changes are documented above

0 commit comments

Comments
 (0)