docs: improvement issue template (#5955)

* docs: improvement issue template

* docs: add issue template for docs

* docs: add issue template for proposal

* delete file

* docs: update bug template
This commit is contained in:
Fabi 2023-05-31 13:55:30 +02:00 committed by GitHub
parent d5eaa8fa16
commit 7a0fa2aad0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 151 additions and 24 deletions

View File

@ -1,7 +1,7 @@
name: Bug Report name: Bug Report
description: "Create a bug report to help us improve ZITADEL. Click [here](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#product-management) to see how we process your issue." description: "Create a bug report to help us improve ZITADEL. Click [here](https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#product-management) to see how we process your issue."
title: "[Bug]: " title: "[Bug]: "
labels: ["type: bug", "state: triage"] labels: ["bug"]
body: body:
- type: markdown - type: markdown
attributes: attributes:
@ -27,11 +27,16 @@ body:
- Self-hosted - Self-hosted
validations: validations:
required: true required: true
- type: textarea - type: input
id: description id: version
attributes: attributes:
label: Describe the bug label: Version
description: A clear and concise description of what the bug is. description: Which version of ZITADEL are you using.
- type: textarea
id: impact
attributes:
label: Describe the problem caused by this bug
description: A clear and concise description of the problem you have and what the bug is.
validations: validations:
required: true required: true
- type: textarea - type: textarea
@ -57,11 +62,6 @@ body:
attributes: attributes:
label: Expected behavior label: Expected behavior
description: A clear and concise description of what you expected to happen. description: A clear and concise description of what you expected to happen.
- type: input
id: version
attributes:
label: Version
description: Which version of ZITADEL are you using.
- type: textarea - type: textarea
id: os id: os
attributes: attributes:

31
.github/ISSUE_TEMPLATE/docs.yaml vendored Normal file
View File

@ -0,0 +1,31 @@
name: 📄 Documentation
description: Create an issue for missing or wrong documentation.
title:
labels: ["docs"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this issue.
- type: checkboxes
id: preflight
attributes:
label: Preflight Checklist
options:
- label:
I could not find a solution in the existing issues, docs, nor discussions
required: true
- label:
I have joined the [ZITADEL chat](https://zitadel.com/chat)
- type: textarea
id: docs
attributes:
label: Describe the docs your are missing or that are wrong
placeholder: As a [type of user], I want [some goal] so that [some reason].
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Context
description: Please add any other infos that could be useful.

55
.github/ISSUE_TEMPLATE/improvement.yaml vendored Normal file
View File

@ -0,0 +1,55 @@
name: 🛠️ Improvement
description:
title:
labels: ["improvement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this improvement request
- type: checkboxes
id: preflight
attributes:
label: Preflight Checklist
options:
- label:
I could not find a solution in the existing issues, docs, nor discussions
required: true
- label:
I have joined the [ZITADEL chat](https://zitadel.com/chat)
- type: textarea
id: problem
attributes:
label: Describe your problem
description: Please describe your problem this improvement is supposed to solve.
placeholder: Describe the problem you have
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe your ideal solution
description: Which solution do you propose?
placeholder: As a [type of user], I want [some goal] so that [some reason].
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: Which version of the ZITADEL are you using.
- type: dropdown
id: environment
attributes:
label: Environment
description: How do you use ZITADEL?
options:
- ZITADEL Cloud
- Self-hosted
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Context
description: Please add any other infos that could be useful.

55
.github/ISSUE_TEMPLATE/proposal.yaml vendored Normal file
View File

@ -0,0 +1,55 @@
name: 💡 Proposal / Feature request
description:
title:
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this proposal / feature reqeust
- type: checkboxes
id: preflight
attributes:
label: Preflight Checklist
options:
- label:
I could not find a solution in the existing issues, docs, nor discussions
required: true
- label:
I have joined the [ZITADEL chat](https://zitadel.com/chat)
- type: textarea
id: problem
attributes:
label: Describe your problem
description: Please describe your problem this proposal / feature is supposed to solve.
placeholder: Describe the problem you have.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe your ideal solution
description: Which solution do you propose?
placeholder: As a [type of user], I want [some goal] so that [some reason].
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: Which version of ZITADEL are you using.
- type: dropdown
id: environment
attributes:
label: Environment
description: How do you use ZITADEL?
options:
- ZITADEL Cloud
- Self-hosted
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Context
description: Please add any other infos that could be useful.

View File

@ -1,14 +0,0 @@
---
name: User Story
about: A user story is a brief description of a feature that has to be implemented from the perspective of the end user.
title: ''
assignees: ''
---
As a [type of user], I want [some goal] so that [some reason].
```[tasklist]
### Acceptance Criteria
- [ ] ...
```