Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Apr 22, 2024
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6359ee1
Modify `CONTRIBUTING.md` and the issue templates `bug_report.yml` and…
graphemecluster Apr 18, 2024
fb1b3b4
Remove Duplicate Content, Unemphasize “search engine”
graphemecluster Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ 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.

Besides searching in GitHub, you should also search for `site:github.com/microsoft/TypeScript <your keywords>` in your favorite **search engine** for more relevant and accurate results.
graphemecluster marked this conversation as resolved.
Show resolved Hide resolved

Please fill in each section completely. Thank you!
- type: textarea
id: search_terms
attributes:
Expand Down
15 changes: 10 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!
graphemecluster marked this conversation as resolved.
Show resolved Hide resolved

🔎 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.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
graphemecluster marked this conversation as resolved.
Show resolved Hide resolved

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.
Expand Down