doc: update issues and PRs templates.

This commit is contained in:
Ludovic Fernandez 2019-10-09 14:28:04 +02:00 committed by Traefiker Bot
parent ff31e75ccc
commit 1a6bef1a7e
5 changed files with 36 additions and 44 deletions

View file

@ -1,3 +1,7 @@
<!-- PLEASE FOLLOW THE ISSUE TEMPLATE TO HELP TRIAGE AND SUPPORT! -->
### Do you want to request a *feature* or report a *bug*?
<!-- <!--
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS. DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
@ -8,21 +12,12 @@ For end-user related support questions, please refer to one of the following:
--> -->
Bug
### Do you want to request a *feature* or report a *bug*?
<!--
If you intend to ask a support question: DO NOT FILE AN ISSUE.
-->
### Did you try using a 1.7.x configuration for the version 2.0?
- [ ] Yes
- [ ] No
<!-- <!--
If you just checked the "Yes" box, be aware that this is probably not a bug. The configurations between 1.X and 2.X are NOT compatible. Please have a look here https://docs.traefik.io/v2.0/getting-started/configuration-overview/. The configurations between 1.X and 2.X are NOT compatible.
Please have a look here https://docs.traefik.io/v2.0/getting-started/configuration-overview/.
--> -->
@ -30,7 +25,7 @@ If you just checked the "Yes" box, be aware that this is probably not a bug. The
<!-- <!--
HOW TO WRITE A GOOD ISSUE? HOW TO WRITE A GOOD BUG REPORT?
- Respect the issue template as much as possible. - Respect the issue template as much as possible.
- The title should be short and descriptive. - The title should be short and descriptive.
@ -52,13 +47,12 @@ HOW TO WRITE A GOOD ISSUE?
### Output of `traefik version`: (_What version of Traefik are you using?_) ### Output of `traefik version`: (_What version of Traefik are you using?_)
<!-- <!--
`latest` is not considered as a valid version.
For the Traefik Docker image: For the Traefik Docker image:
docker run [IMAGE] version docker run [IMAGE] version
ex: docker run traefik version ex: docker run traefik version
For the alpine Traefik Docker image:
docker run [IMAGE] traefik version
ex: docker run traefik traefik version
--> -->
``` ```
@ -70,12 +64,13 @@ For the alpine Traefik Docker image:
```toml ```toml
# (paste your configuration here) # (paste your configuration here)
``` ```
<!-- <!--
Add more configuration information here. Add more configuration information here.
--> -->
### If applicable, please paste the log output at DEBUG level (`--log.level=DEBUG` switch) ### If applicable, please paste the log output in DEBUG level (`--log.level=DEBUG` switch)
``` ```
(paste your output here) (paste your output here)

View file

@ -3,6 +3,9 @@ name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
--- ---
<!-- PLEASE FOLLOW THE ISSUE TEMPLATE TO HELP TRIAGE AND SUPPORT! -->
### Do you want to request a *feature* or report a *bug*?
<!-- <!--
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS. DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
@ -14,19 +17,12 @@ For end-user related support questions, please refer to one of the following:
--> -->
### Do you want to request a *feature* or report a *bug*?
Bug Bug
### Did you try using a 1.7.x configuration for the version 2.0?
- [ ] Yes
- [ ] No
<!-- <!--
If you just checked the "Yes" box, be aware that this is probably not a bug. The configurations between 1.X and 2.X are NOT compatible. Please have a look here https://docs.traefik.io/v2.0/getting-started/configuration-overview/. The configurations between 1.X and 2.X are NOT compatible.
Please have a look here https://docs.traefik.io/v2.0/getting-started/configuration-overview/.
--> -->
@ -56,13 +52,12 @@ HOW TO WRITE A GOOD BUG REPORT?
### Output of `traefik version`: (_What version of Traefik are you using?_) ### Output of `traefik version`: (_What version of Traefik are you using?_)
<!-- <!--
`latest` is not considered as a valid version.
For the Traefik Docker image: For the Traefik Docker image:
docker run [IMAGE] version docker run [IMAGE] version
ex: docker run traefik version ex: docker run traefik version
For the alpine Traefik Docker image:
docker run [IMAGE] traefik version
ex: docker run traefik traefik version
--> -->
``` ```

View file

@ -3,6 +3,9 @@ name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
--- ---
<!-- PLEASE FOLLOW THE ISSUE TEMPLATE TO HELP TRIAGE AND SUPPORT! -->
### Do you want to request a *feature* or report a *bug*?
<!-- <!--
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS. DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
@ -14,9 +17,6 @@ For end-user related support questions, please refer to one of the following:
--> -->
### Do you want to request a *feature* or report a *bug*?
Feature Feature
### What did you expect to see? ### What did you expect to see?

View file

@ -1,18 +1,19 @@
<!-- <!--
PLEASE READ THIS MESSAGE. PLEASE READ THIS MESSAGE.
HOW TO WRITE A GOOD PULL REQUEST? Documentation fixes or enhancements:
- for Traefik v1: use branch v1.7
- for Traefik v2: use branch v2.0
- Make it small. Bug fixes:
- Do only one thing. - for Traefik v1: use branch v1.7
- Avoid re-formatting. - for Traefik v2: use branch v2.0
- Make sure the code builds.
- Make sure all tests pass. Enhancements:
- Add tests. - for Traefik v1: we only accept bug fixes
- Write useful descriptions and titles. - for Traefik v2: use branch master
- Address review comments in terms of additional commits.
- Do not amend/squash existing ones unless the PR is trivial. HOW TO WRITE A GOOD PULL REQUEST? https://docs.traefik.io/contributing/submitting-pull-requests/
- Read the contributing guide: https://github.com/containous/traefik/blob/master/CONTRIBUTING.md.
--> -->

View file

@ -1,3 +1,4 @@
# Contributing # Contributing
See <https://docs.traefik.io/v2.0/contributing/thank-you/>. - https://docs.traefik.io/contributing/submitting-pull-requests/
- https://docs.traefik.io/contributing/submitting-issues/