From a01cbb42c71bb3357e8cd97936f802bec08ccf0e Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Thu, 24 Jun 2021 08:52:13 +0200 Subject: [PATCH] Convert issue templates to issue forms. --- .github/ISSUE_TEMPLATE/Bug_report.md | 82 ---------------------- .github/ISSUE_TEMPLATE/Feature_request.md | 35 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 80 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 33 +++++++++ 4 files changed, 113 insertions(+), 117 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 9a3f7ea76..000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - - -### Do you want to request a *feature* or report a *bug*? - - - -Bug - - - -### What did you do? - - - -### What did you expect to see? - - - -### What did you see instead? - - - -### Output of `traefik version`: (_What version of Traefik are you using?_) - - - -``` -(paste your output here) -``` - -### What is your environment & configuration (arguments, toml, provider, platform, ...)? - -```toml -# (paste your configuration here) -``` - - - - -### If applicable, please paste the log output in DEBUG level (`--log.level=DEBUG` switch) - -``` -(paste your output here) -``` diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index 2495c9aec..000000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - - -### Do you want to request a *feature* or report a *bug*? - - - -Feature - -### What did you expect to see? - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..b81ede4f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,80 @@ +name: Bug Report (Traefik) +description: Create a report to help us improve. +body: + - type: checkboxes + id: terms + attributes: + label: Welcome! + description: | + The issue tracker is for reporting bugs and feature requests only. For end-user related support questions, please refer to one of the following: + - the Traefik community forum: https://community.containo.us/ + + The configurations between 1.X and 2.X are NOT compatible. Please have a look [here](https://doc.traefik.io/traefik/getting-started/configuration-overview/). + + DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS. + options: + - label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/traefik/issues) and didn't find any. + required: true + - label: Yes, I've searched similar issues on the [Traefik community forum](https://community.containo.us) and didn't find any. + required: true + + - type: textarea + attributes: + label: What did you do? + description: | + How to write a good bug report? + + - Respect the issue template as much as possible. + - The title should be short and descriptive. + - Explain the conditions which led you to report 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) + placeholder: What did you do? + validations: + required: true + + - type: textarea + attributes: + label: What did you see instead? + placeholder: What did you see instead? + validations: + required: true + + - type: textarea + attributes: + label: What version of Traefik are you using? + description: | + `latest` is not considered as a valid version. + + Output of `traefik version`. + + For the Traefik Docker image (`docker run [IMAGE] version`), example: + ```console + $ docker run traefik version + ``` + placeholder: Paste your output here. + validations: + required: true + + - type: textarea + attributes: + label: What is your environment & configuration? + description: arguments, toml, provider, platform, ... + placeholder: Add information here. + value: | + ```yaml + # (paste your configuration here) + ``` + + Add more configuration information here. + validations: + required: true + + - type: textarea + attributes: + label: If applicable, please paste the log output in DEBUG level + description: "`--log.level=DEBUG` switch." + placeholder: Paste your output here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..bcea354ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,33 @@ +name: Feature Request (Traefik) +description: Suggest an idea for this project. +body: + - type: checkboxes + id: terms + attributes: + label: Welcome! + description: | + The issue tracker is for reporting bugs and feature requests only. For end-user related support questions, please refer to one of the following: + - the Traefik community forum: https://community.containo.us/ + + DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS. + options: + - label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/traefik/issues) and didn't find any. + required: true + - label: Yes, I've searched similar issues on the [Traefik community forum](https://community.containo.us) and didn't find any. + required: true + + - type: textarea + attributes: + label: What did you expect to see? + description: | + How to write a good issue? + + - Respect the issue template as much as possible. + - The title should be short and descriptive. + - Explain the conditions which led you to report 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) + placeholder: What did you expect to see? + validations: + required: true