chore: add GitHub issue forms
Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
This commit is contained in:
Mark Sagi-Kazar
parent
59c7e20c3c
commit
452d466481
4 changed files with 123 additions and 48 deletions
2
.github/ISSUE_TEMPLATE/.editorconfig
vendored
Normal file
2
.github/ISSUE_TEMPLATE/.editorconfig
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
[*.md]
|
||||
indent_size = 2
|
||||
124
.github/ISSUE_TEMPLATE/bug_report.md
vendored
124
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,38 +1,100 @@
|
|||
---
|
||||
name: 🐛 Bug report
|
||||
about: Report a bug to help us improve Dex
|
||||
---
|
||||
<!--
|
||||
Thank you for sending a bug report! Here are some tips:
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for submitting a bug report!
|
||||
|
||||
1. Please fill out the template below to make it easier to debug your problem.
|
||||
2. If you are not sure if it is a bug or not, you can ask in the CNCF slack channel `#dexidp`.
|
||||
-->
|
||||
Please fill out the template below to make it easier to debug your problem.
|
||||
|
||||
#### Expected behavior (what you expected to happen)
|
||||
If you are not sure if it is a bug or not, you can contact us via the available [support channels](https://github.com/dexidp/dex/issues/new/choose).
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Preflight Checklist
|
||||
description: Please ensure you've completed all of the following.
|
||||
options:
|
||||
- label: I agree to follow the [Code of Conduct](https://github.com/dexidp/dex/blob/master/.github/CODE_OF_CONDUCT.md) that this project adheres to.
|
||||
required: true
|
||||
- label: I have searched the [issue tracker](https://www.github.com/dexidp/dex/issues) for an issue that matches the one I want to file, without success.
|
||||
required: true
|
||||
- label: I am not looking for support or already pursued the available [support channels](https://github.com/dexidp/dex/issues/new/choose) without success.
|
||||
required: true
|
||||
- type: input
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of Dex are you using?
|
||||
placeholder: 2.28.1
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Storage Type
|
||||
options:
|
||||
- etcd
|
||||
- Kubernetes
|
||||
- In-memory
|
||||
- Postgres
|
||||
- MySQL
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Installation Type
|
||||
description: Official container image, Helm chart, etc.
|
||||
options:
|
||||
- Binary
|
||||
- Official container image
|
||||
- Official Helm chart
|
||||
- Custom container image
|
||||
- Custom Helm chart
|
||||
- Other (specify below)
|
||||
multiple: true
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual Behavior
|
||||
description: A clear description of what actually happens.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps To Reproduce
|
||||
description: Steps to reproduce the behavior if it is not self-explanatory.
|
||||
placeholder: |
|
||||
1. In this environment...
|
||||
2. With this config...
|
||||
3. Run '...'
|
||||
4. See error...
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: Links? References? Anything that will give us more context about the issue that you are encountering!
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Configuration
|
||||
description: Contents of your configuration file (if relevant).
|
||||
render: yaml
|
||||
placeholder: |
|
||||
issuer: http://127.0.0.1:5556/dex
|
||||
|
||||
#### Actual behavior (what actually happened)
|
||||
storage:
|
||||
# ...
|
||||
|
||||
#### Steps to reproduce
|
||||
connectors:
|
||||
# ...
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
#### Environment
|
||||
|
||||
- Dex version:
|
||||
- Storage type:
|
||||
- Installation type (official docker image, helm chart, etc.):
|
||||
|
||||
#### Anything else we should know?
|
||||
|
||||
#### Additional information for debugging (if necessary)
|
||||
|
||||
<details><summary>Configuration</summary><br><pre>
|
||||
|
||||
</pre></details>
|
||||
|
||||
<details><summary>Logs</summary><br><pre>
|
||||
|
||||
</pre></details>
|
||||
staticClients:
|
||||
# ...
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Logs
|
||||
description: Dex application logs (if relevant).
|
||||
render: shell
|
||||
|
|
|
|||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -2,7 +2,7 @@ blank_issues_enabled: false
|
|||
contact_links:
|
||||
- name: ❓ Ask a question
|
||||
url: https://github.com/dexidp/dex/discussions/new?category=q-a
|
||||
about: Ask and discuss questions with other Dex community members
|
||||
about: Ask and discuss questions with other Dex community members
|
||||
|
||||
- name: 📚 Documentation
|
||||
url: https://dexidp.io/docs/
|
||||
|
|
|
|||
43
.github/ISSUE_TEMPLATE/feature_request.md
vendored
43
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -1,20 +1,31 @@
|
|||
---
|
||||
name: 🚀 Feature request
|
||||
about: Suggest an idea for Dex
|
||||
---
|
||||
<!--
|
||||
Thank you for sending a feature request!
|
||||
Please describe what you would like to change/add and why in detail by filling out the template below.
|
||||
-->
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for submitting a feature request!
|
||||
|
||||
#### Is your feature request related to a problem?
|
||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
Please describe what you would like to change/add and why in detail by filling out the template below.
|
||||
|
||||
#### Describe the solution you'd like to see
|
||||
<!-- A clear and concise description of what would you like to happen. -->
|
||||
|
||||
#### Describe alternatives you've considered
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
#### Additional context
|
||||
<!-- Add any other context or screenshots about the feature request here. -->
|
||||
If you are not sure if your request fits into Dex, you can contact us via the available [support channels](https://github.com/dexidp/dex/issues/new/choose).
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Problem Description
|
||||
description: Please add a clear and concise description of the problem you are seeking to solve with this feature request.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Proposed Solution
|
||||
description: Describe the solution you'd like in a clear and concise manner.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Alternatives Considered
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: Add any other context about the problem here.
|
||||
|
|
|
|||
Reference in a new issue