Browse Source

feat(github): add github issue templates

Add issue templates for github bug reports, feature requests and pull
requests to help gather as much information as possible from users
submitting issues or PR's.

Templates generated with the help of:
https://www.talater.com/open-source-templates/#/page/1
renovate/lint-staged-8.x
Tom Kirkpatrick 6 years ago
parent
commit
047aa94b69
No known key found for this signature in database GPG Key ID: 72203A8EC5967EA8
  1. 44
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 27
      .github/ISSUE_TEMPLATE/feature_request.md
  3. 37
      .github/PULL_REQUEST_TEMPLATE.md

44
.github/ISSUE_TEMPLATE/bug_report.md

@ -0,0 +1,44 @@
---
name: Bug report
about: Create a report to help us improve
---
<!--- Provide a general summary of the issue in the Title above -->
## Description
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->
## Expected Behavior
<!--- Tell us what should happen -->
## Actual Behavior
<!--- Tell us what happens instead -->
## Possible Fix
<!--- Not obligatory, but suggest a fix or reason for the bug -->
## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
- 1.
- 2.
- 3.
- 4.
## Context
<!--- How has this bug affected you? What were you trying to accomplish? -->
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
- Zap Desktop version:
- Operating System and version:

27
.github/ISSUE_TEMPLATE/feature_request.md

@ -0,0 +1,27 @@
---
name: Feature request
about: Suggest an idea for this project
---
<!--- Provide a general summary of the issue in the Title above -->
## Detailed Description
<!--- Provide a detailed description of the change or addition you are proposing -->
## Context
<!--- Why is this change important to you? How would you use it? -->
<!--- How can it benefit other users? -->
## Possible Implementation
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
- Zap Desktop version:
- Operating System and version:

37
.github/PULL_REQUEST_TEMPLATE.md

@ -0,0 +1,37 @@
<!--- Provide a general summary of your changes in the Title above -->
## Description:
<!--- Describe your changes in detail -->
## Motivation and Context:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
## Screenshots (if appropriate):
## Types of changes:
<!--- What types of changes does your code introduce? -->
<!--- Bug fix? (non-breaking change which fixes an issue)? -->
<!--- New feature? (non-breaking change which adds functionality) -->
<!--- Breaking change? (fix or feature that would cause existing functionality to change) -->
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] I have reviewed and updated the documentation accordingly.
- [ ] I have read the _CONTRIBUTING_ document.
- [ ] I have added tests to cover my changes where needed.
- [ ] All new and existing tests passed.
- [ ] My commits have been squashed into a concise set of changes.
Loading…
Cancel
Save