Skip to content

Commit

Permalink
chore: improve issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ldez committed Jul 3, 2021
1 parent e53767d commit 6b38e0b
Show file tree
Hide file tree
Showing 5 changed files with 140 additions and 74 deletions.
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Bug Report
description: Create a report to help us improve Traefik Mesh.
labels: ['status/0-needs-triage']
body:
- type: markdown
attributes:
value: |
**DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.**
The issue tracker is for reporting bugs and feature requests only.
For end-user related support questions, please use the [Traefik Mesh community forum](https://community.traefik.io/c/traefik-mesh).
### 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)
- type: checkboxes
id: terms
attributes:
label: Welcome!
options:
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/mesh/issues) and didn't find any.
required: true
- label: Yes, I've searched similar issues on the [Traefik Mesh community forum](https://community.traefik.io/c/traefik-mesh) and didn't find any.
required: true

- type: textarea
id: expect
attributes:
label: What did you expect to see?
description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: What did you expect to see?
validations:
required: true

- type: textarea
id: instead
attributes:
label: What did you see instead?
description: Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: What did you see instead?
validations:
required: true

- type: input
id: version
attributes:
label: What version of Traefik Mesh are you using?
description: |
`latest` is not considered as a valid version.
We need a release number!
validations:
required: true

- type: textarea
id: controller
attributes:
label: Output of controller log
placeholder: paste your output here
render: shell
validations:
required: true

- type: textarea
id: environment
attributes:
label: What is your environment & configuration?
description: |
arguments, YAML, TOML, provider, platform, etc.
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: Add information here.
validations:
required: true

- type: textarea
id: objects
attributes:
label: If applicable, please paste the yaml objects required to reproduce your issue
placeholder: Paste your objects here
render: shell
validations:
required: false
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ contact_links:
- name: Question
about: Please ask and answer questions here.
url: https://community.traefik.io/c/traefik-mesh

- name: Documentation
url: https://doc.traefik.io/traefik-mesh/
about: Please take a look to our documenation.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Feature Request
description: Propose a change to Traefik Mesh!
labels: ['status/0-needs-triage']
body:
- type: checkboxes
id: terms
attributes:
label: Welcome!
options:
- label: Yes, I've searched similar issues on [GitHub](https://github.com/traefik/mesh/issues) and didn't find any.
required: true
- label: Yes, I've searched similar issues on the [Traefik Mesh community forum](https://community.traefik.io/c/traefik-mesh) and didn't find any.
required: true

- type: textarea
id: proposal
attributes:
label: Proposal
description: |
Write your feature request in the form of a proposal to be considered for implementation.
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: Write your feature request in the form of a proposal to be considered for implementation.
validations:
required: true

- type: textarea
id: background
attributes:
label: Background
description: |
Describe the background problem or need that led to this feature request.
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: Describe the background problem or need that led to this feature request.
validations:
required: true

- type: textarea
id: workarounds
attributes:
label: Workarounds
description: |
Are there any current workarounds that you're using that others in similar positions should know?
Use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) if needed.
placeholder: Are there any current workarounds that you're using that others in similar positions should know?
validations:
required: true

0 comments on commit 6b38e0b

Please sign in to comment.