doc: Enhance GitHub issue template.
This commit is contained in:
parent
1e84e77a67
commit
d5efc99876
2 changed files with 39 additions and 27 deletions
34
.github/ISSUE_TEMPLATE.md
vendored
34
.github/ISSUE_TEMPLATE.md
vendored
|
@ -1,16 +1,30 @@
|
||||||
<!--
|
<!--
|
||||||
PLEASE READ THIS MESSAGE.
|
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
|
||||||
|
|
||||||
=== DO *NOT* FILE ISSUES FOR GENERAL SUPPORT QUESTIONS. ===
|
The issue tracker is for reporting bugs and feature requests only.
|
||||||
|
For end-user related support questions, refer to one of the following:
|
||||||
The issue tracker is for reporting bugs and feature requests only. For end-user related support questions, refer to one of the following:
|
|
||||||
|
|
||||||
- Stack Overflow (using the "traefik" tag): https://stackoverflow.com/questions/tagged/traefik
|
- Stack Overflow (using the "traefik" tag): https://stackoverflow.com/questions/tagged/traefik
|
||||||
- the Traefik community Slack channel: https://traefik.herokuapp.com
|
- the Traefik community Slack channel: https://traefik.herokuapp.com
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Do you want to request a *feature* or report a *bug*?
|
||||||
|
|
||||||
|
(If you intend to ask a support question: **DO NOT FILE AN ISSUE**.
|
||||||
|
Use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik)
|
||||||
|
or [Slack](https://traefik.herokuapp.com) instead.)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### What did you do?
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
HOW TO WRITE A GOOD ISSUE?
|
HOW TO WRITE A GOOD ISSUE?
|
||||||
|
|
||||||
- if it's possible use the command `traefik bug`. See https://www.youtube.com/watch?v=Lyz62L8m93I.
|
- Respect the issue template as more as possible.
|
||||||
|
- If it's possible use the command `traefik bug`. See https://www.youtube.com/watch?v=Lyz62L8m93I.
|
||||||
- The title must be short and descriptive.
|
- The title must be short and descriptive.
|
||||||
- Explain the conditions which led you to write this issue: the context.
|
- Explain the conditions which led you to write this issue: the context.
|
||||||
- The context should lead to something, an idea or a problem that you’re facing.
|
- The context should lead to something, an idea or a problem that you’re facing.
|
||||||
|
@ -19,16 +33,6 @@ HOW TO WRITE A GOOD ISSUE?
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
### Do you want to request a *feature* or report a *bug*?
|
|
||||||
|
|
||||||
(If you intend to ask a support question: **DO NOT FILE AN ISSUE**. Use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik) or [Slack](https://traefik.herokuapp.com) instead.)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### What did you do?
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### What did you expect to see?
|
### What did you expect to see?
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -17,18 +17,32 @@ import (
|
||||||
var (
|
var (
|
||||||
bugtracker = "https://github.com/containous/traefik/issues/new"
|
bugtracker = "https://github.com/containous/traefik/issues/new"
|
||||||
bugTemplate = `<!--
|
bugTemplate = `<!--
|
||||||
PLEASE READ THIS MESSAGE.
|
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
|
||||||
|
|
||||||
Please keep in mind that the GitHub issue tracker is not intended as a general support forum, but for reporting bugs and feature requests.
|
The issue tracker is for reporting bugs and feature requests only.
|
||||||
|
For end-user related support questions, refer to one of the following:
|
||||||
For other type of questions, consider using one of:
|
|
||||||
|
|
||||||
|
- Stack Overflow (using the "traefik" tag): https://stackoverflow.com/questions/tagged/traefik
|
||||||
- the Traefik community Slack channel: https://traefik.herokuapp.com
|
- the Traefik community Slack channel: https://traefik.herokuapp.com
|
||||||
- StackOverflow: https://stackoverflow.com/questions/tagged/traefik
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Do you want to request a *feature* or report a *bug*?
|
||||||
|
|
||||||
|
(If you intend to ask a support question: **DO NOT FILE AN ISSUE**.
|
||||||
|
Use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik)
|
||||||
|
or [Slack](https://traefik.herokuapp.com) instead.)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### What did you do?
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
HOW TO WRITE A GOOD ISSUE?
|
HOW TO WRITE A GOOD ISSUE?
|
||||||
|
|
||||||
- if it's possible use the command` + "`" + `traefik bug` + "`" + `. See https://www.youtube.com/watch?v=Lyz62L8m93I.
|
- Respect the issue template as more as possible.
|
||||||
|
- If it's possible use the command ` + "`" + "traefik bug" + "`" + `. See https://www.youtube.com/watch?v=Lyz62L8m93I.
|
||||||
- The title must be short and descriptive.
|
- The title must be short and descriptive.
|
||||||
- Explain the conditions which led you to write this issue: the context.
|
- Explain the conditions which led you to write this issue: the context.
|
||||||
- The context should lead to something, an idea or a problem that you’re facing.
|
- The context should lead to something, an idea or a problem that you’re facing.
|
||||||
|
@ -37,12 +51,6 @@ HOW TO WRITE A GOOD ISSUE?
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
### Do you want to request a *feature* or report a *bug*?
|
|
||||||
|
|
||||||
|
|
||||||
### What did you do?
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### What did you expect to see?
|
### What did you expect to see?
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue