Create Issue templates (#456)

* Add a template for feature requests

* Add a issue template for bugs

* Add a template for questions

* Add issue template for the documentation

* Add Gitter chat to the issue creation dialog

* Address comments from @NextTurn
pull/468/head
Oleg Nenashev 2020-03-31 11:13:13 +02:00 committed by GitHub
parent 7554777d8e
commit fb15bf108b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 73 additions and 0 deletions

View File

@ -0,0 +1,16 @@
---
name: "🚀 Feature request"
labels: new-feature
about: I have a suggestion (and may want to implement it 🙂)!
---
### Feature Request
**Problem statement.**
A clear and concise description of what the problem is. Ex. `I have an issue when [...]`, `As a WinSW user, I want to [...]`
**Describe the solution you'd like.**
Add any considered drawbacks.
**Describe alternatives you've considered.**
A clear and concise description of any alternative solutions or features you've considered.

28
.github/ISSUE_TEMPLATE/2-bug-report.md vendored Normal file
View File

@ -0,0 +1,28 @@
---
name: "🐛 Bug report"
labels: bug
about: Create a bug report to help us improve
---
**Summary**. Describe the expected and actual behavior here.
## Steps to reproduce
Please clarify how to reproduce the issue.
If you need to attach your configuration, please do it pelow:
```xml
TODO
```
## Environment
* WinSW version: TODO
* WinSW package type: TODO (e.g. .NET 4.6.1 )
* Windows version: TODO
* Wrapped executable and version: TODO <!-- e.g. "internal project", "Jenkins 2.222.1"-->
## Possible Solution
If you have suggestions on a fix for the bug, please describe it here.

View File

@ -0,0 +1,8 @@
---
name: ":pencil: Documentation"
labels: documentation
about: Let us know if any documentation is missing or could be improved
---
**Summary**. Describe your use-case which is not covered by existing documentation.
If it is easier to submit a documentation patch instead of writing an issue, just do it!

16
.github/ISSUE_TEMPLATE/4-question.md vendored Normal file
View File

@ -0,0 +1,16 @@
---
name: "❓ Need help"
labels: question
about: Please ask in our Gitter channel first
---
---
We primarily use GitHub as an issue tracker.
For usage and support questions, please ask in our [Gitter chat](https://gitter.im/winsw/winsw) first.
Thanks!
---
### Problem statement
Please describe your issue here, and explain what you have already tried to resolve it.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Gitter chat
url: https://gitter.im/winsw/winsw
about: Please ask and answer questions here.