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 diff --git a/docs/content/contributing/maintainers-guidelines.md b/docs/content/contributing/maintainers-guidelines.md index 3c7fc3cdd..11ce90a4f 100644 --- a/docs/content/contributing/maintainers-guidelines.md +++ b/docs/content/contributing/maintainers-guidelines.md @@ -1,6 +1,6 @@ -# The Maintainers Guidelines +# Maintainer's Guidelines -![Maintainers Guidelines](../assets/img/maintainers-guidelines.png) +![Maintainer's Guidelines](../assets/img/maintainers-guidelines.png) Note: the document is a work in progress. @@ -13,14 +13,14 @@ and firmly standing against the elitist closed approach. Being part of the core team should be accessible to anyone motivated and wants to be part of that journey! -## Onboarding process +## Onboarding Process If you consider joining our community please drop us a line using Twitter or leave a note in the issue. We will schedule a quick call to meet you and learn more about your motivation. During the call, the team will discuss the process of becoming a maintainer. We will be happy to answer any questions and explain all your doubts. -## Maintainers requirements +## Maintainer's Requirements Note: you do not have to meet all the listed requirements, but must have achieved several. @@ -34,7 +34,7 @@ but must have achieved several. or other technical forums/boards such as K8S slack, Reddit, StackOverflow, hacker news. - Have read and accepted the contributor guidelines. -## Maintainers responsibilities and privileges +## Maintainer's Responsibilities and Privileges There are lots of areas where you can contribute to the project, but we can suggest you start with activities such as: @@ -103,7 +103,7 @@ maintainers' activity and involvement will be reviewed on a regular basis. non-threatening, and friendly behavior towards other people on the maintainer team and with our community? -## Additional comments for (not only) maintainers +## Additional Comments for (not only) Maintainers - Be able to put yourself in users’ shoes. - Be open-minded and respectful with other maintainers and other community members. diff --git a/docs/content/contributing/maintainers.md b/docs/content/contributing/maintainers.md index e6406ac63..179056779 100644 --- a/docs/content/contributing/maintainers.md +++ b/docs/content/contributing/maintainers.md @@ -1,6 +1,6 @@ # Maintainers -## The team +## The Team * Emile Vauge [@emilevauge](https://github.com/emilevauge) * Vincent Demeester [@vdemeester](https://github.com/vdemeester) @@ -20,15 +20,15 @@ * Kevin Pollet [@kevinpollet](https://github.com/kevinpollet) * Harold Ozouf [@jspdown](https://github.com/jspdown) -## Maintainers guidelines +## Maintainer's Guidelines -Please read the [maintainers guidelines](maintainers-guidelines.md) +Please read the [maintainer's guidelines](maintainers-guidelines.md) ## Issue Triage Issues and PRs are triaged daily and the process for triaging may be found under [triaging issues](https://github.com/traefik/contributors-guide/blob/master/issue_triage.md) in our [contributors guide repository](https://github.com/traefik/contributors-guide). -## PR review process: +## PR Review Process The process for reviewing PRs may be found under [review guidelines](https://github.com/traefik/contributors-guide/blob/master/review_guidelines.md) in our contributors guide repository. @@ -118,7 +118,7 @@ The `status/*` labels represent the desired state in the workflow. * `priority/P2`: need to be fixed in the future. * `priority/P3`: maybe. -### PR size +### PR Size Automatically set by a bot.