diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a1249c26ae..caa957348f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,25 +7,29 @@ assignees: '' --- -**Describe the bug** +## Describe the bug + A clear and concise description of what the bug is. -**To Reproduce** +## To Reproduce + Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Perform '....' 4. See error -**Expected behavior** +## Expected behavior + A clear and concise description of what you expected to happen. -**Log** -If applicable, add the Longhorn managers' log when the issue happens. +## Log or Support bundle -You can also attach a *Support Bundle* here. You can generate a Support Bundle using the link at the footer of the Longhorn UI. +If applicable, add the Longhorn managers' log or support bundle when the issue happens. +You can generate a Support Bundle using the link at the footer of the Longhorn UI. + +## Environment -**Environment:** - Longhorn version: - Installation method (e.g. Rancher Catalog App/Helm/Kubectl): - Kubernetes distro (e.g. RKE/K3s/EKS/OpenShift) and version: @@ -40,5 +44,6 @@ You can also attach a *Support Bundle* here. You can generate a Support Bundle u - Underlying Infrastructure (e.g. on AWS/GCE, EKS/GKE, VMWare/KVM, Baremetal): - Number of Longhorn volumes in the cluster: -**Additional context** +## Additional context + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9ca51b4c30..cb48d37200 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,24 @@ --- name: Feature request about: Suggest an idea for this project -title: "[FEATURE]" +title: "[FEATURE] " labels: kind/enhancement assignees: '' --- -**Is your feature request related to a problem? Please describe.** +## 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 [...] -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Describe the solution you'd like + +A clear and concise description of what you want to happen + +## Describe alternatives you've considered -**Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +## Additional context + Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improvement_request.md b/.github/ISSUE_TEMPLATE/improvement_request.md new file mode 100644 index 0000000000..76794382fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement_request.md @@ -0,0 +1,24 @@ +--- +name: Improvement request +about: Suggest an improvement of an existing feature for this project +title: "[IMPROVEMENT] " +labels: kind/improvement +assignees: '' + +--- + +## Is your improvement request related to a feature? Please describe + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +## Describe the solution you'd like + +A clear and concise description of what you want 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. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 56cba7d8ab..6ffaa4a98b 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,14 +1,16 @@ --- name: Question about: Question on Longhorn -title: "[QUESTION]" +title: "[QUESTION] " labels: kind/question assignees: '' --- -**Question** +## Question +> Suggest to use https://github.com/longhorn/longhorn/discussions to ask questions. + +## Environment -**Environment:** - Longhorn version: - Kubernetes version: - Node config @@ -19,5 +21,6 @@ assignees: '' - Network bandwidth and latency between the nodes: - Underlying Infrastructure (e.g. on AWS/GCE, EKS/GKE, VMWare/KVM, Baremetal): -**Additional context** +## Additional context + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md index 51e58a7631..77192e460e 100644 --- a/.github/ISSUE_TEMPLATE/task.md +++ b/.github/ISSUE_TEMPLATE/task.md @@ -1,16 +1,21 @@ --- name: Task about: Task on Longhorn -title: "[TASK]" +title: "[TASK] " labels: kind/task assignees: '' --- -**What's the task? Please describe.** + +## What's the task? Please describe + A clear and concise description of what the task is. -**Describe the items of the task (DoD, definition of done) you'd like.** -- [ ] +## Describe the items of the task (DoD, definition of done) you'd like +> Please use a task list for items on a separate line with a clickable checkbox https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists + +- [ ] `item 1` + +## Additional context -**Additional context** Add any other context or screenshots about the task request here. diff --git a/.github/ISSUE_TEMPLATE/test.md b/.github/ISSUE_TEMPLATE/test.md index 32c6e001fa..e12ce3d189 100644 --- a/.github/ISSUE_TEMPLATE/test.md +++ b/.github/ISSUE_TEMPLATE/test.md @@ -1,16 +1,21 @@ --- name: Test -about: Test implementation on Longhorn -title: "[TEST]" +about: Test task on Longhorn +title: "[TEST] " labels: kind/test assignees: '' --- -**What's the test to develop? Please describe.** + +## What's the test to develop? Please describe + A clear and concise description of what the test you want to develop. -**Describe the items of the test development (DoD, definition of done) you'd like.** -- [ ] +## Describe the items of the test development (DoD, definition of done) you'd like +> Please use a task list for items on a separate line with a clickable checkbox https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists + +- [ ] `item 1` + +## Additional context -**Additional context** Add any other context or screenshots about the test request here.