Skip to content

Commit 6322f64

Browse files
committed
Adding GitHub Issue and PR templates
1 parent da0b3e8 commit 6322f64

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
In order to efficiently and accurately address your issue or feature request, please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. Please delete any sections or questions below that do not pertain to this request.
2+
3+
For general support or usage questions, please use the [Auth0 Community](https://community.auth0.com/) or [Auth0 Support](https://support.auth0.com/).
4+
5+
### Description
6+
7+
Description of the bug or feature request and why it's a problem. Consider including:
8+
9+
- The use case or overall problem you're trying to solve
10+
- Information about when the problem started
11+
12+
### Prerequisites
13+
14+
- [ ] I have checked the [Auth0 Community](https://community.auth0.com/) for related posts.
15+
- [ ] I have checked for related or duplicate [Issues](https://github.com/auth0/auth0-java-mvc-common/issues) and [PRs](https://github.com/auth0/auth0-java-mvc-common/pulls).
16+
- [ ] I have read the [Auth0 general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md).
17+
- [ ] I have read the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
18+
19+
### Environment
20+
21+
Please provide the following:
22+
23+
- Version of this library used:
24+
- Version of Java used:
25+
- Additional libraries that might be affecting your instance:
26+
27+
### Reproduction
28+
29+
Detail the steps taken to reproduce this error and note if this issue can be reproduced consistently or if it is intermittent.
30+
31+
Please include:
32+
33+
- Code sample to reproduce the issue
34+
- Log files (redact/remove sensitive information)
35+
- Application settings (redact/remove sensitive information)
36+
- Screenshots, if helpful

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### Changes
2+
3+
Please describe both what is changing and why this is important. Include:
4+
5+
- Endpoints added, deleted, deprecated, or changed
6+
- Classes and methods added, deleted, deprecated, 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 API (this should also be added to relevant documentation once released)
9+
- Any alternative designs or approaches considered
10+
11+
### References
12+
13+
Please include relevant links supporting this change such as a:
14+
15+
- support ticket
16+
- community post
17+
- StackOverflow post
18+
- support forum thread
19+
20+
### Testing
21+
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/or integration testing, tests should be added for new functionality and existing tests should complete without errors.
23+
24+
- [ ] This change adds test coverage
25+
- [ ] This change has been tested on the latest version of Java or why not
26+
27+
### Checklist
28+
29+
- [ ] I have read the [Auth0 general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
30+
- [ ] 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)