Added github issues templates #1952
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| blank_issues_enabled: true | ||
| issue_templates: | ||
| - name: 🔍 Typings Inconsistency | ||
| description: Report inconsistencies between TypeScript's web API typings and browser behavior. | ||
| labels: [lib.d.ts bug] | ||
| file: typings_inconsistency.yml | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| name: "Typings Inconsistency" | ||
| title: "[Typings Inconsistency] " | ||
| labels: [lib.d.ts bug] | ||
| assignees: [] | ||
| description: "Report inconsistencies between TypeScript's web API typings and browser behavior." | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Typings Inconsistency | ||
| Provide details of the inconsistency. | ||
| - type: input | ||
| id: inconsistency_summary | ||
| attributes: | ||
| label: "Summary" | ||
| description: "Brief summary of the inconsistency" | ||
| placeholder: "e.g., Mismatch in event handling..." | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected_vs_actual | ||
| attributes: | ||
| label: "Expected vs. Actual Behavior" | ||
| description: "Describe what you expected and what actually happened" | ||
| placeholder: "Expected: ...\nActual: ..." | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: "Playground link" | ||
| description: "Paste the playground link" | ||
| placeholder: "https://www.typescriptlang.org/play/..." | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: browser_support | ||
| attributes: | ||
| label: "Browser Support" | ||
| description: "Ensure that the API is supported in at least two major browser engines (not two chromiums)." | ||
| options: | ||
| - label: "This API is supported in at least two major browser engines (not two chromiums)." | ||
| validations: | ||
| required: true | ||
| - type: checkbox | ||
| id: use_latest_typescript | ||
| attributes: | ||
| label: "Use Latest TypeScript Package" | ||
| description: "Check this if you are using the latest TypeScript package." | ||
| options: | ||
| - label: "I am using the latest version of TS" | ||
| validations: | ||
| required: true | ||
|
There was a problem hiding this comment. I'd like to add "already tried @types/web package" and "already tried the latest TypeScript release", given people sometimes file issues based on outdated libs. There was a problem hiding this comment. Nothing mentions @types/web though? |
||
| - type: textarea | ||
| id: additional_context | ||
| attributes: | ||
| label: "Additional Context" | ||
| description: "Any extra information, logs, or references" | ||
| placeholder: "Optional details..." | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Huh, I forgot to submit this comment, sorry:
Type definition is what DefinitelyTyped calls it, so let's use that word. Maybe "Web API type definition issue". An issue would be more general than inconsistency which wouldn't cover type enhancements.