From 4900c7f0a8eeafdc72046a91cbe8f46eed62e0d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BD=A2=E7=B4=A0=E5=8F=A2=E9=9B=86=E3=83=BB=E3=81=90?= =?UTF-8?q?=E3=82=89=E3=81=B5=E3=81=83=E3=83=BC=E3=82=80?= Date: Mon, 22 Apr 2024 23:43:49 +0800 Subject: [PATCH] Modify `CONTRIBUTING.md` and the issue templates `bug_report.yml` and `feature_request.yml` to reduce duplicate issues and improve the quality of further submitted issues (#58155) --- .github/ISSUE_TEMPLATE/bug_report.yml | 5 ++++- .github/ISSUE_TEMPLATE/feature_request.yml | 15 ++++++++++----- CONTRIBUTING.md | 2 +- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a8e5e557397..acca35abe99 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -3,7 +3,10 @@ description: 'Create a report to help us improve TypeScript' body: - type: markdown attributes: - value: Please fill in each section completely. Thank you! + value: | + 🔍 Please [search thoroughly in GitHub](https://github.com/Microsoft/TypeScript/search?type=Issues) or by the query `site:github.com/microsoft/TypeScript ` in your favorite search engine before reporting a new bug as most bugs are very likely to find precedents. + + Please fill in each section completely. Thank you! - type: textarea id: search_terms attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index f30ce9bd752..9aee8889c85 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -3,17 +3,22 @@ description: 'Suggest an idea' body: - type: markdown attributes: - value: 'Please fill in each section completely. Thank you!' + value: | + 💡 Did you know? TypeScript has over 2,000 open suggestions! + + 🔎 Please [search thoroughly in GitHub](https://github.com/Microsoft/TypeScript/search?type=Issues) or by the query `site:github.com/microsoft/TypeScript ` in your favorite search engine before logging new feature requests as most common ideas already have a proposal in progress. + + The "Common Feature Requests" section of the FAQ lists many popular requests: https://github.com/Microsoft/TypeScript/wiki/FAQ#common-feature-requests + + Please fill in each section completely. Thank you! - type: textarea id: search_terms attributes: label: '🔍 Search Terms' description: | - 💡 Did you know? TypeScript has over 2,000 open suggestions! + What search terms did you use when trying to find an existing suggestion? - 🔎 Please search thoroughly before logging new feature requests as most common ideas already have a proposal in progress. - - The "Common Feature Requests" section of the FAQ lists many popular requests: https://github.com/Microsoft/TypeScript/wiki/FAQ#common-feature-requests + List them here so people in the future can find this one more easily. placeholder: | List of keywords you searched for before creating this issue. Write them down here so that others can find this suggestion more easily and help provide feedback. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a06539dc34..56912a250f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Issues that ask questions answered in the FAQ will be closed without elaboration ## 2. Search for Duplicates -[Search the existing issues](https://github.com/Microsoft/TypeScript/search?type=Issues) before logging a new one. +[Search the existing issues in GitHub](https://github.com/Microsoft/TypeScript/search?type=Issues) or by the query `site:github.com/microsoft/TypeScript ` in your favorite search engine before logging a new one. Search engines generally list more relevant and accurate results at the top than the GitHub searching feature. Some search tips: * *Don't* restrict your search to only open issues. An issue with a title similar to yours may have been closed as a duplicate of one with a less-findable title.