Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 37e63a4

Browse files
damienglbalmaceda
authored andcommitted
Adding GitHub issue and PR templates (auth0#181)
Add GitHub issue and PR templates
1 parent 8bf0d40 commit 37e63a4

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 documentation for this library [Add a link].
15+
- [ ] I have checked the [Auth0 Community](https://community.auth0.com/) for related posts.
16+
- [ ] I have checked for related or duplicate [Issues](https://github.com/auth0/auth0-python/issues) and [PRs](https://github.com/auth0/auth0-python/pulls).
17+
- [ ] I have read the [Auth0 general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md).
18+
- [ ] I have read the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
19+
- [ ] I am reporting this to the correct repository [Add links to other related].
20+
21+
### Environment
22+
23+
Please provide the following:
24+
25+
- Version of the library being used
26+
- Version of the platform or framework used, if applicable
27+
- Relevant environmental versions (language version, OS version)
28+
- Additional modules/plugins/add-ons that might be affecting your instance
29+
30+
### Reproduction
31+
32+
Detail the steps taken to reproduce this error and note if this issue can be reproduced consistently or if it is intermittent.
33+
34+
Please include:
35+
36+
- Code sample to reproduce the issue
37+
- Log files (redact/remove sensitive information)
38+
- Application settings (redact/remove sensitive information)
39+
- Screenshots, if helpful

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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 unit test coverage
25+
- [ ] This change adds integration test coverage
26+
- [ ] This change has been tested on the latest version of the platform/language or why not
27+
28+
### Checklist
29+
30+
- [ ] I have read the [Auth0 general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
31+
- [ ] I have read the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
32+
- [ ] All existing and new tests complete without errors
33+
- [ ] All code quality tools/guidelines in the [CONTRIBUTING documentation](CONTRIBUTING.md) have been run/followed
34+
- [ ] All relevant assets have been compiled as directed in the [CONTRIBUTING documentation](CONTRIBUTING.md), if applicable
35+
- [ ] The correct base branch is being used, if not `master`

0 commit comments

Comments
 (0)