From 429ce1243437d41d541b10859fb0d24e06124a7a Mon Sep 17 00:00:00 2001 From: Chris Chen Date: Sun, 8 Oct 2023 14:45:24 +0800 Subject: [PATCH] Added issue template (#3025) * Create ISSUE_TEMPLATE * Delete ISSUE_TEMPLATE * Create bug_report.md * Create new_doc_request.md * Update and rename bug_report.md to doc_bug_report.md * Update doc_bug_report.md --- .github/ISSUE_TEMPLATE/doc_bug_report.md | 17 +++++++++++++++++ .github/ISSUE_TEMPLATE/new_doc_request.md | 15 +++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/doc_bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/new_doc_request.md diff --git a/.github/ISSUE_TEMPLATE/doc_bug_report.md b/.github/ISSUE_TEMPLATE/doc_bug_report.md new file mode 100644 index 0000000000..e5690668bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc_bug_report.md @@ -0,0 +1,17 @@ +--- +name: 🐛 Doc Bug Report +about: If something isn't working as expected. + +--- + +# Doc Bug Report + +**This repository is ONLY used to solve issues related to DOCS.** + +Please answer the following questions before submitting your issue. Thanks! + +1. 请提供出现问题的文档链接。What is the URL of the document related to this issue? + + +2. 请简单描述你期望的文档优化方案和理由。How would you like to improve it and why? + diff --git a/.github/ISSUE_TEMPLATE/new_doc_request.md b/.github/ISSUE_TEMPLATE/new_doc_request.md new file mode 100644 index 0000000000..672a17d309 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_doc_request.md @@ -0,0 +1,15 @@ +--- +name: "\U0001F680 New Doc Request" +about: Want to add something new to our doc? +--- + +# New Doc Request +**This repository is ONLY used to solve issues related to DOCS.** + +Please answer the following questions before submitting your issue. Thanks! + +1. 请提供待写入文档的新功能的背景信息，包括但不限于PRD, PR, 或者 Issue链接。Provide background info about the feature to be documented, such as links to PRD, Pull Request, or Issue. + +2. 请提供该新功能可能影响的存量文档的链接。Provide the links of the documents that may be affected by this new feature. + +