From 59f472767575d107e7966d69b1b5a8713936734c Mon Sep 17 00:00:00 2001 From: liukuikun <24622904+Harold-lkk@users.noreply.github.com> Date: Mon, 17 Jul 2023 12:54:54 +0800 Subject: [PATCH] [Enchancement] add more options for issue template (#77) * [Enchancement] add more options for issue template * update qustion icon * fix link --- .github/ISSUE_TEMPLATE/1_bug-report.yml | 15 ++++++++ .github/ISSUE_TEMPLATE/2_question.yml | 24 +++++++++++++ ...ture-request.yml => 3_feature-request.yml} | 15 ++++++++ .github/ISSUE_TEMPLATE/4_document.yml | 35 +++++++++++++++++++ ..._bug-report_zh.yml => 5_bug-report_zh.yml} | 15 ++++++++ .github/ISSUE_TEMPLATE/6_question_zh.yml | 25 +++++++++++++ ...equest_zh.yml => 7_feature-request_zh.yml} | 14 ++++++++ .github/ISSUE_TEMPLATE/8_document_zh.yml | 35 +++++++++++++++++++ 8 files changed, 178 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/2_question.yml rename .github/ISSUE_TEMPLATE/{2_feature-request.yml => 3_feature-request.yml} (60%) create mode 100644 .github/ISSUE_TEMPLATE/4_document.yml rename .github/ISSUE_TEMPLATE/{3_bug-report_zh.yml => 5_bug-report_zh.yml} (73%) create mode 100644 .github/ISSUE_TEMPLATE/6_question_zh.yml rename .github/ISSUE_TEMPLATE/{4_feature-request_zh.yml => 7_feature-request_zh.yml} (68%) create mode 100644 .github/ISSUE_TEMPLATE/8_document_zh.yml diff --git a/.github/ISSUE_TEMPLATE/1_bug-report.yml b/.github/ISSUE_TEMPLATE/1_bug-report.yml index 3088138..ed73e55 100644 --- a/.github/ISSUE_TEMPLATE/1_bug-report.yml +++ b/.github/ISSUE_TEMPLATE/1_bug-report.yml @@ -3,6 +3,13 @@ description: Create a report to help us improve labels: ["bug"] title: "[Bug] " body: + - type: markdown + attributes: + value: | + ## Note + For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/InternLM/InternLM/discussions) + Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** + - type: markdown attributes: value: | @@ -55,3 +62,11 @@ body: 1. Did you make any modifications on the code or config? 2. What do you think might be the reason? + + - type: markdown + attributes: + value: | + ## Acknowledgement + Thanks for taking the time to fill out this report. + + If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [**here**](https://github.com/InternLM/InternLM/pulls)! diff --git a/.github/ISSUE_TEMPLATE/2_question.yml b/.github/ISSUE_TEMPLATE/2_question.yml new file mode 100644 index 0000000..fc123ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_question.yml @@ -0,0 +1,24 @@ +name: "❔ Common Questions" +description: Ask a question about the usage or idea discussions. +labels: [ "question" ] +title: "[QA] " + + +body: + - type: markdown + attributes: + value: | + ## Note + For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/InternLM/InternLM/discussions) + Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** + + - type: textarea + id: describe + validations: + required: true + attributes: + label: Describe the question. + description: | + what is your question? Please provide a clear and concise description of what the question is. + placeholder: | + A clear and concise description of the question. diff --git a/.github/ISSUE_TEMPLATE/2_feature-request.yml b/.github/ISSUE_TEMPLATE/3_feature-request.yml similarity index 60% rename from .github/ISSUE_TEMPLATE/2_feature-request.yml rename to .github/ISSUE_TEMPLATE/3_feature-request.yml index 6e72fb4..ccf279f 100644 --- a/.github/ISSUE_TEMPLATE/2_feature-request.yml +++ b/.github/ISSUE_TEMPLATE/3_feature-request.yml @@ -3,6 +3,13 @@ description: Suggest an idea for this project labels: ["enhancement"] title: "[Feature] " body: + - type: markdown + attributes: + value: | + ## Note + For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/InternLM/InternLM/discussions) + Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** + - type: markdown attributes: value: | @@ -27,3 +34,11 @@ body: label: Will you implement it? options: - label: I would like to implement this feature and create a PR! + + - type: markdown + attributes: + value: | + ## Acknowledgement + Thanks for taking the time to fill out this report. + + If you have already identified the reason, we strongly appreciate you creating a new PR to implement it [**here**](https://github.com/InternLM/InternLM/pulls)! diff --git a/.github/ISSUE_TEMPLATE/4_document.yml b/.github/ISSUE_TEMPLATE/4_document.yml new file mode 100644 index 0000000..53ca9ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_document.yml @@ -0,0 +1,35 @@ +name: 📚 Documentation +description: Report an issue related to the documentation. +labels: "documentation" +title: "[Docs] " + +body: + - type: markdown + attributes: + value: | + ## Note + For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/InternLM/InternLM/discussions) + Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** + + + - type: textarea + attributes: + label: 📚 The doc issue + description: > + A clear and concise description the issue. + validations: + required: true + + - type: textarea + attributes: + label: Suggest a potential alternative/fix + description: > + Tell us how we could improve the documentation in this regard. + + - type: markdown + attributes: + value: | + ## Acknowledgement + Thanks for taking the time to fill out this report. + + If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [**here**](https://github.com/InternLM/InternLM/pulls)! diff --git a/.github/ISSUE_TEMPLATE/3_bug-report_zh.yml b/.github/ISSUE_TEMPLATE/5_bug-report_zh.yml similarity index 73% rename from .github/ISSUE_TEMPLATE/3_bug-report_zh.yml rename to .github/ISSUE_TEMPLATE/5_bug-report_zh.yml index 6fe0d3d..8b237be 100644 --- a/.github/ISSUE_TEMPLATE/3_bug-report_zh.yml +++ b/.github/ISSUE_TEMPLATE/5_bug-report_zh.yml @@ -3,6 +3,13 @@ description: 报告你在使用中遇到的不合预期的情况 labels: ["bug"] title: "[Bug] " body: + - type: markdown + attributes: + value: | + ## 注意 + 对于一般的使用问题或者想法讨论，请在我们的[**论坛**](https://github.com/InternLM/InternLM/discussions) + 请尽可能填写以下表格。**描述得越清楚，解决问题的时间就越短。** + - type: markdown attributes: value: | @@ -56,3 +63,11 @@ body: 1. 你是否对代码或配置文件做了任何改动？ 2. 你认为可能的原因是什么？ + + - type: markdown + attributes: + value: | + ## 致谢 + 感谢你的反馈！ + + 如果你已经找到了错误的原因，我们非常欢迎你直接创建一个新的 PR 来解决这个问题 [**here**](https://github.com/InternLM/InternLM/pulls)! diff --git a/.github/ISSUE_TEMPLATE/6_question_zh.yml b/.github/ISSUE_TEMPLATE/6_question_zh.yml new file mode 100644 index 0000000..b086e7f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/6_question_zh.yml @@ -0,0 +1,25 @@ +name: "❔ 常见问题" +description: 提出一个关于使用或者想法讨论的问题。 +labels: [ "question" ] +title: "[QA] " + + +body: + - type: markdown + attributes: + value: | + ## 注意 + 对于一般的使用问题或者想法讨论，请在我们的[**论坛**](https://github.com/InternLM/InternLM/discussions) + 请尽可能填写以下表格。**描述得越清楚，解决问题的时间就越短。** + + - type: textarea + id: describe + validations: + required: true + attributes: + label: 描述问题 + description: | + what is your question? Please provide a clear and concise description of what the question is. + 你的问题是什么？请提供一个清晰简明的问题描述。 + placeholder: | + 一个清晰简明的问题描述。 diff --git a/.github/ISSUE_TEMPLATE/4_feature-request_zh.yml b/.github/ISSUE_TEMPLATE/7_feature-request_zh.yml similarity index 68% rename from .github/ISSUE_TEMPLATE/4_feature-request_zh.yml rename to .github/ISSUE_TEMPLATE/7_feature-request_zh.yml index 929e6f0..9b25443 100644 --- a/.github/ISSUE_TEMPLATE/4_feature-request_zh.yml +++ b/.github/ISSUE_TEMPLATE/7_feature-request_zh.yml @@ -3,6 +3,12 @@ description: 建议一项新的功能 labels: ["enhancement"] title: "[Feature] " body: + - type: markdown + attributes: + value: | + ## 注意 + 对于一般的使用问题或者想法讨论，请在我们的[**论坛**](https://github.com/InternLM/InternLM/discussions) + 请尽可能填写以下表格。**描述得越清楚，解决问题的时间就越短。** - type: markdown attributes: value: | @@ -29,3 +35,11 @@ body: label: 是否希望自己实现该功能？ options: - label: 我希望自己来实现这一功能，并向 InternLM 贡献代码！ + + - type: markdown + attributes: + value: | + ## 致谢 + 感谢你的反馈！ + + 如果您自己可以实现该功能，我们非常欢迎你直接创建一个新的 PR [**here**](https://github.com/InternLM/InternLM/pulls)! diff --git a/.github/ISSUE_TEMPLATE/8_document_zh.yml b/.github/ISSUE_TEMPLATE/8_document_zh.yml new file mode 100644 index 0000000..a70ddd1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/8_document_zh.yml @@ -0,0 +1,35 @@ +name: 📚 文档 +description: 提出文档中的错误或者提出文档改进的建议 +labels: "documentation" +title: "[Docs] " + +body: + - type: markdown + attributes: + value: | + ## 注意 + 对于一般的使用问题或者想法讨论，请在我们的[**论坛**](https://github.com/InternLM/InternLM/discussions) + 请尽可能填写以下表格。**描述得越清楚，解决问题的时间就越短。** + + + - type: textarea + attributes: + label: 📚 描述文档中的错误 + description: > + 请简要说明你在文档中发现的错误 + validations: + required: true + + - type: textarea + attributes: + label: 📚 描述文档中的改进建议 + description: > + 请简要说明你对文档的改进建议 + + - type: markdown + attributes: + value: | + ## 致谢 + 感谢你的反馈！ + + 如果你已经找到了错误的原因，我们非常欢迎你直接创建一个新的 PR 来解决这个问题 [**here**](https://github.com/InternLM/InternLM/pulls)!