docs: add proposal issue template #55
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| name: Bug Report | ||
| description: "Create a bug report to help us improve ZITADEL SAML Library." | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| - type: checkboxes | ||
| id: preflight | ||
| attributes: | ||
| label: Preflight Checklist | ||
| options: | ||
| - label: | ||
| I could not find a solution in the documentation, the existing issues or discussions | ||
| required: true | ||
| - label: | ||
| I have joined the [ZITADEL chat](https://zitadel.com/chat) | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: Which version of the SAML Library 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: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduce | ||
| attributes: | ||
| label: To reproduce | ||
| description: Steps to reproduce the behaviour | ||
| placeholder: | | ||
| Steps to reproduce the behavior: | ||
| 1. ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots | ||
| description: If applicable, add screenshots to help explain your problem. | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected behavior | ||
| description: A clear and concise description of what you expected to happen. | ||
| - type: textarea | ||
| id: additional | ||
| attributes: | ||
| label: Additional Context | ||
| description: Please add any other infos that could be useful. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,4 @@ | ||
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: 💬 ZITADEL Community Chat | ||
| url: https://zitadel.com/chat |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: 📄 Documentation | ||
| description: Create an issue for missing or wrong documentation. | ||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| name: 🛠️ Improvement | ||
| description: "Create an new issue for an improvment in ZITADEL" | ||
| 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 SAML Library 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| name: 💡 Proposal / Feature request | ||
| description: "Create an issue for a feature request/proposal." | ||
| 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 the SAML Library are you using. | ||
| - type: dropdown | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: How do you use ZITADEL? | ||
| options: | ||
| - ZITADEL Cloud | ||
| - Self-hosted | ||
| validations: | ||
| required: true | ||
|
Comment on lines
+40
to
+49
There was a problem hiding this comment. The library is not only intended to be used with ZITADEL, right @stebenz? If not particularly, I'd replace this field. Maybe, the apps that are connected are interesting? There was a problem hiding this comment. You are right didn't think about this. |
||
| - type: textarea | ||
| id: additional | ||
| attributes: | ||
| label: Additional Context | ||
| description: Please add any other infos that could be useful. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better a field for logs @stebenz?
Maybe also a field for config?