Merge pull request #1515 from ldez/github-template-again

doc: enhance Github templates.
traefik · May 1, 2017 · eefcf02 · eefcf02
2 parents 78f1b42 + ccb1a4f
commit eefcf02
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 47 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -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*?

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -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

diff --git a/.github/how-to-write-a-good-issue.md b/.github/how-to-write-a-good-issue.md
diff --git a/.github/how-to-write-a-good-pull-request.md b/.github/how-to-write-a-good-pull-request.md
diff --git a/cmd/traefik/bug.go b/cmd/traefik/bug.go
@@ -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*?