Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: enhance Github templates. #1515

Merged
merged 1 commit into from
May 1, 2017
Merged

doc: enhance Github templates. #1515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 16 additions & 3 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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*?
Expand Down
16 changes: 13 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
25 changes: 0 additions & 25 deletions .github/how-to-write-a-good-issue.md
View file
Open in desktop

This file was deleted.

13 changes: 0 additions & 13 deletions .github/how-to-write-a-good-pull-request.md
View file
Open in desktop

This file was deleted.

19 changes: 16 additions & 3 deletions cmd/traefik/bug.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*?
Expand Down