From 5b3479fdc77deaa732a2afd8b81c848abfb1489a Mon Sep 17 00:00:00 2001 From: Xiangyu Wang Date: Tue, 20 Apr 2021 16:42:08 +0800 Subject: [PATCH] [skip ci]Update issue template (#4966) Signed-off-by: Xiangyu Wang --- .github/ISSUE_TEMPLATE/bug_report.md | 6 ++-- .github/ISSUE_TEMPLATE/config.yml | 5 +++ .../ISSUE_TEMPLATE/documentation-request.md | 35 +++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.md | 15 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 6 ++-- 5 files changed, 61 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation-request.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e66fb7f5a1..6fe7d24d07 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 +name: "\U0001F41B Bug report" +about: Create a bug report to help us improve Milvus title: '' labels: '' assignees: '' --- -**Please state your issue using the following template in English.** +**Please state your issue using the following template and, most importantly, in English.** **Describe the bug** A clear and concise description of what the bug is. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..83b2650966 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/milvus-io/milvus/discussions + about: Ask questions and discuss with other community members diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md new file mode 100644 index 0000000000..53e480d8d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-request.md @@ -0,0 +1,35 @@ +--- +name: "\U0001F4DD Documentation request" +about: Report incorrect or needed documentation +title: '' +labels: '' +assignees: '' + +--- + +**Please state your issue using the following template and, most importantly, in English.** + +**Location of incorrect documentation** +Provide links and line numbers if applicable. + +**Describe the problems or issues found in the documentation** +A clear and concise description of what you found to be incorrect. + +**Steps taken to verify documentation is incorrect** +List any steps you have taken: + +**Suggested fix for documentation** +Detail proposed changes to fix the documentation if you have any. + +--- + +## Report needed documentation + +**Report needed documentation** +A clear and concise description of what documentation you believe it is needed and why. + +**Describe the documentation you'd like** +A clear and concise description of what you want to happen. + +**Steps taken to search for needed documentation** +List any steps you have taken: diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000000..74ed61e07a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,15 @@ +--- +name: "Enhancement request" +about: Suggest an enhancement idea for Milvus +title: '' +labels: '' +assignees: '' + +--- + +**Please state your issue using the following template and, most importantly, in English.** + +**What would you like to be added ?** + +**Why is this needed ?** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 57b24bc4cc..8b027b4e03 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,13 +1,13 @@ --- -name: Feature request -about: Suggest an idea for this project +name: "\U0001F680 Feature request" +about: Suggest an idea for Milvus title: '' labels: '' assignees: '' --- -**Please state your issue using the following template in English.** +**Please state your issue using the following template and, most importantly, in English.** **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. E.g. I wish I could use Milvus to do [...]