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)

This commit is contained in:
形素叢集・ぐらふぃーむ 2024-04-22 23:43:49 +08:00 коммит произвёл GitHub
Родитель 21b5c9624c
Коммит 4900c7f0a8
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
3 изменённых файлов: 15 добавлений и 7 удалений

5
.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 <your keywords>` 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:

15
.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 <your keywords>` 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.

Просмотреть файл

@ -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 <your keywords>` 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.