From f57e05cbed5973d27a77af294f6df0863d657528 Mon Sep 17 00:00:00 2001 From: David Ko Date: Mon, 7 Nov 2022 13:59:24 +0800 Subject: [PATCH] Update issue templates Signed-off-by: David Ko --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/doc.md | 21 ++++++++++++++++ .../{feature_request.md => feature.md} | 4 ++-- ...{improvement_request.md => improvement.md} | 4 ++-- .github/ISSUE_TEMPLATE/question.md | 2 +- .github/ISSUE_TEMPLATE/refactor.md | 24 +++++++++++++++++++ .github/ISSUE_TEMPLATE/task.md | 2 +- .github/ISSUE_TEMPLATE/test.md | 2 +- .github/ISSUE_TEMPLATE/test_infra.md | 21 ++++++++++++++++ 9 files changed, 75 insertions(+), 9 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/doc.md rename .github/ISSUE_TEMPLATE/{feature_request.md => feature.md} (90%) rename .github/ISSUE_TEMPLATE/{improvement_request.md => improvement.md} (86%) create mode 100644 .github/ISSUE_TEMPLATE/refactor.md create mode 100644 .github/ISSUE_TEMPLATE/test_infra.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index caa9573..6b48d44 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,13 +1,13 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a bug report title: "[BUG]" labels: kind/bug assignees: '' --- -## Describe the bug +## Describe the bug (🐛 if you encounter this issue) A clear and concise description of what the bug is. diff --git a/.github/ISSUE_TEMPLATE/doc.md b/.github/ISSUE_TEMPLATE/doc.md new file mode 100644 index 0000000..d028512 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc.md @@ -0,0 +1,21 @@ +--- +name: Document +about: Create or update document +title: "[DOC] " +labels: kind/doc +assignees: '' + +--- + +## What's the task? Please describe + +A clear and concise description of what the document is. + +## 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 + +Add any other context or screenshots about the document request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature.md similarity index 90% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/feature.md index cb48d37..a03c634 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -1,13 +1,13 @@ --- name: Feature request -about: Suggest an idea for this project +about: Suggest an idea/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 (👍 if you like this request) A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/.github/ISSUE_TEMPLATE/improvement_request.md b/.github/ISSUE_TEMPLATE/improvement.md similarity index 86% rename from .github/ISSUE_TEMPLATE/improvement_request.md rename to .github/ISSUE_TEMPLATE/improvement.md index 7679438..e257057 100644 --- a/.github/ISSUE_TEMPLATE/improvement_request.md +++ b/.github/ISSUE_TEMPLATE/improvement.md @@ -1,13 +1,13 @@ --- name: Improvement request -about: Suggest an improvement of an existing feature for this project +about: Suggest an improvement of an existing feature title: "[IMPROVEMENT] " labels: kind/improvement assignees: '' --- -## Is your improvement request related to a feature? Please describe +## Is your improvement request related to a feature? Please describe (👍 if you like this request) A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 6ffaa4a..3e7d04d 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,6 +1,6 @@ --- name: Question -about: Question on Longhorn +about: Have a question title: "[QUESTION] " labels: kind/question assignees: '' diff --git a/.github/ISSUE_TEMPLATE/refactor.md b/.github/ISSUE_TEMPLATE/refactor.md new file mode 100644 index 0000000..212994c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/refactor.md @@ -0,0 +1,24 @@ +--- +name: Refactoring request +about: Suggest a refactoring request of an existing feature or design +title: "[REFACTORING] " +labels: kind/refactoring +assignees: '' + +--- + +## Is your improvement request related to a feature? Please describe + +A clear and concise description of what the problem is. + +## 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 refactoring request here. diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md index 77192e4..e9d7d7b 100644 --- a/.github/ISSUE_TEMPLATE/task.md +++ b/.github/ISSUE_TEMPLATE/task.md @@ -1,6 +1,6 @@ --- name: Task -about: Task on Longhorn +about: Create a general task title: "[TASK] " labels: kind/task assignees: '' diff --git a/.github/ISSUE_TEMPLATE/test.md b/.github/ISSUE_TEMPLATE/test.md index e12ce3d..df7da88 100644 --- a/.github/ISSUE_TEMPLATE/test.md +++ b/.github/ISSUE_TEMPLATE/test.md @@ -1,6 +1,6 @@ --- name: Test -about: Test task on Longhorn +about: Create or update test title: "[TEST] " labels: kind/test assignees: '' diff --git a/.github/ISSUE_TEMPLATE/test_infra.md b/.github/ISSUE_TEMPLATE/test_infra.md new file mode 100644 index 0000000..4a5473e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/test_infra.md @@ -0,0 +1,21 @@ +--- +name: Test infra +about: Create a test-infra task +title: "[TEST-INFRA] " +labels: kind/test +assignees: '' + +--- + +## What's the test to develop? Please describe + +A clear and concise description of what the test infra you want to develop. + +## 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 + +Add any other context or screenshots about the test infra request here.