From aea702e3d4279859ee803c305be78390058e8be3 Mon Sep 17 00:00:00 2001 From: Yichao Yang <1048262223@qq.com> Date: Sun, 12 Jul 2020 08:42:55 +0800 Subject: [PATCH] [Feature][docs] Add the issue template according to the issue specification (#3185) Co-authored-by: dailidong --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 7 +++++- .../ISSUE_TEMPLATE/improvement_suggestion.md | 22 +++++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 8 +++---- .github/ISSUE_TEMPLATE/test.md | 22 +++++++++++++++++++ 5 files changed, 56 insertions(+), 7 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/improvement_suggestion.md create mode 100644 .github/ISSUE_TEMPLATE/test.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dc797cf0a8..11751bd184 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,7 +1,7 @@ --- name: Bug report about: Create a report to help us improve -title: "[BUG] bug title " +title: "[Bug][Module Name] Bug title " labels: bug assignees: '' @@ -32,5 +32,5 @@ If applicable, add screenshots to help explain your problem. **Additional context** Add any other context about the problem here. -**Requirement or improvement +**Requirement or improvement** - Please describe about your requirements or improvement suggestions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 8cd481d442..eb71fc3bbd 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,12 +1,17 @@ --- name: Feature request about: Suggest an idea for this project -title: "[Feature]" +title: "[Feature][Module Name] Feature title" labels: new feature assignees: '' --- +*For better global communication, please give priority to using English description, thx! * + +**Describe the feature** +A clear and concise description of what the feature is. + **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 [...] diff --git a/.github/ISSUE_TEMPLATE/improvement_suggestion.md b/.github/ISSUE_TEMPLATE/improvement_suggestion.md new file mode 100644 index 0000000000..44f8f48e8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement_suggestion.md @@ -0,0 +1,22 @@ +--- +name: Improvement suggestion +about: Improvement suggestion for this project +title: "[Improvement][Module Name] Improvement title" +labels: improvement +assignees: '' + +--- + +*For better global communication, please give priority to using English description, thx! * + +**Describe the question** +A clear and concise description of what the improvement is. + +**What are the current deficiencies and the benefits of improvement** +- A clear and concise description of the current deficiencies and the benefits of this improvement. + +**Which version of DolphinScheduler:** + -[1.1.0-preview] + +**Describe alternatives you've considered** +A clear and concise description of any alternative improvement solutions you've considered. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 59c8ce7716..891aff292b 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,7 +1,7 @@ --- -name: question -about: have a question wanted to be help -title: "[QUESTION] question title" +name: Question +about: Have a question wanted to be help +title: "[Question] Question title" labels: question assignees: '' @@ -19,5 +19,5 @@ A clear and concise description of what the question is. **Additional context** Add any other context about the problem here. -**Requirement or improvement +**Requirement or improvement** - Please describe about your requirements or improvement suggestions. diff --git a/.github/ISSUE_TEMPLATE/test.md b/.github/ISSUE_TEMPLATE/test.md new file mode 100644 index 0000000000..59a5b61a64 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/test.md @@ -0,0 +1,22 @@ +--- +name: Test +about: Test to enhance the robustness of this project +title: "[Test][Module Name] Test title" +labels: test +assignees: '' + +--- + +*For better global communication, please give priority to using English description, thx! * + +**Describe the question** +A clear and concise description of what the test part is. + +**What are the current deficiencies and the benefits of changing or adding this test** +- A clear and concise description of the current deficiencies, the benefits of changing or adding this test, and the scope involved. + +**Which version of DolphinScheduler:** + -[1.1.0-preview] + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions you've considered. \ No newline at end of file