1
0
Fork 0

doc: enhance GitHub template.

- add issue and PR guide.
- rewrite templates
This commit is contained in:
Fernandez Ludovic 2017-04-22 17:49:26 +02:00 committed by Fernandez Ludovic
parent 4f2a2d573d
commit ccff8a80f5
6 changed files with 101 additions and 21 deletions

25
.github/how-to-write-a-good-issue.md vendored Normal file
View file

@ -0,0 +1,25 @@
# How to write a good issue
Please keep in mind that the GitHub issue tracker is not intended as a general support forum, but for reporting bugs and feature requests.
For other type of questions, consider using one of:
- the [Traefik community Slack channel](https://traefik.herokuapp.com)
- [StackOverflow](https://stackoverflow.com/questions/tagged/traefik)
## Title
The title must be short and descriptive.
## Description of the issue
- Explain the conditions which led you to write this issue: the context.
- The context should lead to something, an idea or a problem that youre facing.
- Remain clear and concise.
## Format your messages
Help the reader focus on what matters and understand the structure of your message.
[GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown) has a simple but effective syntax: make use of bold text, lists, check-boxes, syntax highlighting, headers, lists, links and images.