baalajimaestro/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

doc: enhance Github templates.

Browse source 
- suppress the mini user guide.
- explain the 'traefik bug' command.
This commit is contained in:
Fernandez Ludovic 2017-04-30 12:53:42 +02:00 committed by Emile Vauge
parent 78f1b4216e
commit ccb1a4ff8c
No known key found for this signature in database
GPG key ID: D808B4C167352E59
5 changed files with 45 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
.github/ISSUE_TEMPLATE.md vendored
View file

@ -1,9 +1,22 @@
<!--
How to write a good issue?
PLEASE READ THIS MESSAGE.
Read https://github.com/containous/traefik/blob/master/.github/how-to-write-a-good-issue.md
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
HOW TO WRITE A GOOD ISSUE?
- if it's possible use the command `traefik bug`. See https://www.youtube.com/watch?v=Lyz62L8m93I.
- The title must be short and descriptive.
- 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.
- Remain clear and concise.
- Format your messages to help the reader focus on what matters and understand the structure of your message, use Markdown syntax https://help.github.com/articles/github-flavored-markdown
And the contributing guide: https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md
-->
### Do you want to request a *feature* or report a *bug*?

16
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,9 +1,19 @@
<!--
How to write a good pull request?
PLEASE READ THIS MESSAGE.
Read https://github.com/containous/traefik/blob/master/.github/how-to-write-a-good-pull-request.md.
HOW TO WRITE A GOOD PULL REQUEST?
- Make it small.
- Do only one thing.
- Avoid re-formatting.
- Make sure the code builds.
- Make sure all tests pass.
- Add tests.
- Write useful descriptions and titles.
- Address review comments in terms of additional commits.
- Do not amend/squash existing ones unless the PR is trivial.
- Read the contributing guide: https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md.
And the contributing guide: https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md.
-->
### Description

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

@ -1,25 +0,0 @@
# 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 you’re 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.

13
.github/how-to-write-a-good-pull-request.md vendored
View file

@ -1,13 +0,0 @@
# How to write a good pull request
- Make it small
- Do only one thing
- Avoid re-formatting
- Make sure the code builds
- Make sure all tests pass
- Add tests
- Write useful descriptions and titles
- Address review comments in terms of additional commits.
- Do not amend/squash existing ones unless the PR is trivial.
Read [10 tips for better pull requests](http://blog.ploeh.dk/2015/01/15/10-tips-for-better-pull-requests/).

19
cmd/traefik/bug.go
View file

@ -17,11 +17,24 @@ import (
var (
bugtracker = "https://github.com/containous/traefik/issues/new"
bugTemplate = `<!--
How to write a good issue?
PLEASE READ THIS MESSAGE.
Read https://github.com/containous/traefik/blob/master/.github/how-to-write-a-good-issue.md
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
HOW TO WRITE A GOOD ISSUE?
- if it's possible use the command` + "`" + `traefik bug` + "`" + `. See https://www.youtube.com/watch?v=Lyz62L8m93I.
- The title must be short and descriptive.
- 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.
- Remain clear and concise.
- Format your messages to help the reader focus on what matters and understand the structure of your message, use Markdown syntax https://help.github.com/articles/github-flavored-markdown
And the contributing guide: https://github.com/containous/traefik/blob/master/.github/CONTRIBUTING.md
-->
### Do you want to request a *feature* or report a *bug*?