Skip to content

Commit 7338b64

Browse files
marci4marci4
committed
Issue and Pull Request templates
Added a template for issues as well as pull requests
1 parent 2a49ceb commit 7338b64

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
## Expected Behavior
4+
<!--- If you're describing a bug, tell us what should happen -->
5+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
6+
7+
## Current Behavior
8+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
9+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
10+
11+
## Possible Solution
12+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
13+
<!--- or ideas how to implement the addition or change -->
14+
15+
## Steps to Reproduce (for bugs)
16+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
17+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
18+
1.
19+
2.
20+
3.
21+
4.
22+
23+
## Debug log (for bugs)
24+
<!--- Please provide a debug log for your issue. -->
25+
<!--- You can activate the debug log with 'WebSocketImpl.DEBUG = true;' -->
26+
27+
## Context
28+
<!--- How has this issue affected you? What are you trying to accomplish? -->
29+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
30+
31+
## Your Environment
32+
<!--- Include as many relevant details about the environment you experienced the bug in -->
33+
* Version used:
34+
* Java version:
35+
* Operating System and version:
36+
* Endpoint Name and version:
37+
* Link to your project:

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
<!--- This project only accepts pull requests related to open issues -->
8+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
<!--- Please link to the issue here: -->
11+
12+
## Motivation and Context
13+
<!--- Why is this change required? What problem does it solve? -->
14+
15+
## How Has This Been Tested?
16+
<!--- Please describe in detail how you tested your changes. -->
17+
<!--- Include details of your testing environment, and the tests you ran to -->
18+
<!--- see how your change affects other areas of the code, etc. -->
19+
20+
## Types of changes
21+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
22+
- [ ] Bug fix (non-breaking change which fixes an issue)
23+
- [ ] New feature (non-breaking change which adds functionality)
24+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
25+
26+
## Checklist:
27+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
28+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
29+
- [ ] My code follows the code style of this project.
30+
- [ ] My change requires a change to the documentation.
31+
- [ ] I have updated the documentation accordingly.
32+
- [ ] I have added tests to cover my changes.
33+
- [ ] All new and existing tests passed.

0 commit comments

Comments
 (0)