From 6500fdbdd1be1dd285b94ad7d4047fd9d1b577d1 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar <mark.sagikazar@gmail.com> Date: Thu, 5 Nov 2020 11:44:16 +0100 Subject: [PATCH] Improve issue templates Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ++++++++++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++++++--- 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index af98a2f5..eb6dde6c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,28 +3,34 @@ name: 🐛 Bug report about: Report a bug to help us improve Dex --- <!-- -Thank you for sending a bug report! Here some tips: +Thank you for sending a bug report! Here are some tips: -1. Please fill the template below to make it easier to debug your problem. -2. If you are not sure is it a bug or not, you can ask your question in the Kubernetes slack channel `#dexidp` +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 Kubernetes slack channel `#dexidp`. --> **Expected behavior (what you expected to happen)**: **Actual behavior (what actually happened)**: -**Steps how to reproduce it**: +**Steps to reproduce**: 1. ... 2. ... 3. ... -**Anything else we need to know?**: - **Environment**: - Dex version: - Storage type: - Installation type (official docker image, helm chart, etc.): -**Additional information for debugging (is necessary)**: -- Dex configuration: -- Dex logs during the problem: +**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> diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index a181b428..38201bb4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,9 +4,17 @@ about: Suggest an idea for Dex --- <!-- Thank you for sending a feature request! - Please describe in detail what do you want and why by filling the template below. + Please describe what you would like to change/add and why in detail by filling out the template below. --> -**What would you like to be added/changed**: +**Is your feature request related to a problem? Please describe.** +<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> -**Why we need this**: +**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. --> -- GitLab