diff options
Diffstat (limited to '.github')
-rw-r--r-- | .github/FEATURE_PROPOSAL_TEMPLATE.md | 14 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 34 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 28 |
3 files changed, 76 insertions, 0 deletions
diff --git a/.github/FEATURE_PROPOSAL_TEMPLATE.md b/.github/FEATURE_PROPOSAL_TEMPLATE.md new file mode 100644 index 000000000..164844c54 --- /dev/null +++ b/.github/FEATURE_PROPOSAL_TEMPLATE.md | |||
@@ -0,0 +1,14 @@ | |||
1 | <!--- Provide a general summary of your changes in the Title above --> | ||
2 | |||
3 | ### Feature Description | ||
4 | <!--- Describe your feature in detail --> | ||
5 | |||
6 | ### Motivation and Context | ||
7 | <!--- | ||
8 | * Why is this change required? | ||
9 | * How is this improving the Franz experience? | ||
10 | * What problem does it solve? | ||
11 | --> | ||
12 | |||
13 | ### Mockups, Screenshots (if available): | ||
14 | <!--- A picture says more than a thousand words. --> | ||
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..d766f756b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md | |||
@@ -0,0 +1,34 @@ | |||
1 | <!--- Provide a general summary of the issue in the Title above --> | ||
2 | |||
3 | <!--- If you want to propose a feature, use this template: https://github.com/meetfranz/franz/.github/FEATURE_PROPOSAL_TEMPLATE.md --> | ||
4 | |||
5 | ### Expected Behavior | ||
6 | <!--- If you're describing a bug, tell us what should happen --> | ||
7 | <!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
8 | |||
9 | ### Current Behavior | ||
10 | <!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
11 | <!--- If suggesting a change/improvement, explain the difference from current behavior --> | ||
12 | |||
13 | ### Screenshots (if appropriate): | ||
14 | |||
15 | ### Possible Solution | ||
16 | <!--- Not obligatory, but suggest a fix/reason for the bug, --> | ||
17 | <!--- or ideas how to implement the addition or change --> | ||
18 | |||
19 | ### Steps to Reproduce (for bugs) | ||
20 | <!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
21 | <!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
22 | 1. | ||
23 | 2. | ||
24 | 3. | ||
25 | 4. | ||
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 | * Franz Version used: | ||
34 | * Operating System and version: | ||
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..6c4384695 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md | |||
@@ -0,0 +1,28 @@ | |||
1 | <!--- Provide a general summary of your changes in the Title above --> | ||
2 | |||
3 | ### Description | ||
4 | <!--- Describe your changes in detail --> | ||
5 | |||
6 | ### Motivation and Context | ||
7 | <!--- Why is this change required? What problem does it solve? --> | ||
8 | <!--- If it fixes an open issue, please link to the issue here. --> | ||
9 | |||
10 | ### How Has This Been Tested? | ||
11 | <!--- Please describe in detail how you tested your changes. --> | ||
12 | <!--- Include details of your testing environment, tests ran to see how --> | ||
13 | <!--- your change affects other areas of the code, etc. --> | ||
14 | |||
15 | ### Screenshots (if appropriate): | ||
16 | |||
17 | ### Types of changes | ||
18 | <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
19 | - [ ] Bug fix (non-breaking change which fixes an issue) | ||
20 | - [ ] New feature (non-breaking change which adds functionality) | ||
21 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
22 | |||
23 | ### Checklist: | ||
24 | <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
25 | <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
26 | - [ ] My code follows the code style of this project (run `$ yarn lint`). | ||
27 | <!---- [ ] My change requires a change to the documentation. | ||
28 | - [ ] I have updated the documentation accordingly. --> | ||