Skip to content

Commit 48c8a3d

Browse files
authored
Merge pull request #2603 from garden-co/PR-template-v2-simplify
simplify PR template for ease of use
2 parents 31bb120 + 5a8a62b commit 48c8a3d

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

.github/pull_request_template.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
1-
### What this Does
2-
Brief summary of the change, ideally framed in user or product terms.
1+
# Description
2+
<!-- Please include a summary of the change and which issue is fixed -->
3+
<!-- Please also include relevant motivation and context -->
4+
<!-- Include any links to documentation like RFC’s if necessary -->
5+
<!-- Add a link to to relevant preview environments or anything that would simplify visual review process -->
6+
<!-- Supplemental screenshots and video are encouraged, but the primary description should be in text -->
37

4-
### Why Are We Doing This?
5-
Link to the shaped pitch or explain what problem it solves.
8+
## Manual testing instructions
69

7-
### Scope / Boundaries
8-
Includes:
9-
- [x] Core feature functionality
10-
- [x] Tests or validation steps
10+
<!-- Add any actions required to manually test the changes -->
1111

12-
Do NOT include:
13-
- [ ] Related stretch features or follow-ups
12+
## Tests
1413

15-
### Testing Instructions
16-
How a reviewer or QA can verify behavior, offer step-by-step instructions if possible. Screenshots or recordings are welcome.
14+
- [ ] Tests have been added and/or updated
15+
- [ ] Tests have not been updated, because: <!-- Insert reason for not updating tests here -->
16+
- [ ] I need help with writing tests
1717

18-
### Known Issues / Open Questions (if any)
19-
- [ ] Note anything you’d like review on or decided async
2018

21-
### Related Links
22-
- GitHub issue
23-
- Linear pitch
24-
- Design links or references
19+
## Checklist
20+
21+
- [ ] I've updated the part of the docs that are affected the PR changes
22+
- [ ] I've generated a changeset, if a version bump is required
23+
- [ ] I've updated the jsDoc comments to the public APIs I've modified, or added them when missing

0 commit comments

Comments
 (0)