Skip to content

Commit 459ab5d

Browse files
Merge pull request #259 from auth0/fix/pr-template
chore(core,react): update pr template
2 parents e25bff5 + 8f82480 commit 459ab5d

1 file changed

Lines changed: 26 additions & 16 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,41 @@
1-
### Changes
1+
### Summary
22

3-
Please describe both what is changing and why this is important. Include:
3+
<!-- One or two sentences describing what this PR does. -->
44

5-
- Components added, deleted, or changed
6-
- Functions added, deleted, or changed
7-
- Screenshots of new or changed UI, if applicable
8-
- A summary of usage if this is a new feature or change to a public Component (this should also be added to relevant documentation once released)
9-
- Any alternative designs or approaches considered
5+
### Why
106

11-
### References
7+
<!-- The problem or motivation behind this change. -->
8+
9+
### What
10+
11+
<!-- Key changes made in this PR. -->
12+
13+
**Packages**
14+
15+
- [ ] `packages/core`
16+
- [ ] `packages/react`
17+
- [ ] `examples`
1218

13-
Please include relevant links supporting this change such as a:
19+
### References
1420

15-
- support ticket
16-
- community post
17-
- StackOverflow post
18-
- support forum thread
21+
<!-- Link any related issues, tickets, or discussions.
22+
For UI changes, include screenshots or a screen recording (before/after). -->
1923

2024
### Testing
2125

22-
Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and tests should be added for new functionality and existing tests should complete without errors.
26+
How can this be verified? Note anything intentionally not covered by tests and why.
2327

2428
- [ ] This change adds unit test coverage
25-
- [ ] This change has been tested on the latest version of the platform/language or why not
29+
- [ ] Tested for both SPA and RWA flows, all example apps working
30+
- [ ] All existing and new tests complete without errors
2631

2732
### Checklist
2833

34+
- [ ] Breaking change
35+
- [ ] Requires docs update
36+
- [ ] Backward compatible
37+
38+
### Contributing
39+
2940
- [ ] I have read the [Auth0 general contribution guidelines](https://github.com/auth0/.github/blob/master/CONTRIBUTING.md)
3041
- [ ] I have read the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
31-
- [ ] All existing and new tests complete without errors

0 commit comments

Comments
 (0)