Added github issues templates #1952
Conversation
|
Sounds nice to have modern templates. IMO almost everything filed in this repo is about typing issue though, so I doubt we need to have multiple templates. We can start with one and let people use blank template if it doesn't fit. |
Sure |
|
Done @saschanaz |
|
Should we add here the faq about two needed engines: |
| attributes: | ||
| label: "Steps to Reproduce" | ||
| description: "List steps to reproduce the issue" | ||
| placeholder: "Step 1, Step 2, Step 3..." |
There was a problem hiding this comment.
For this repo we don't really need repro steps, a playground link would be the best.
.github/ISSUE_TEMPLATE/config.yml
Outdated
| issue_templates: | ||
| - name: 🔍 Typings Inconsistency | ||
| description: Report inconsistencies between TypeScript's DOM typings and browser behavior. | ||
| labels: [inconsistency] |
There was a problem hiding this comment.
Maybe reuse an existing label - lib.d.ts bug?
| title: "[Typings Inconsistency] " | ||
| labels: [inconsistency] | ||
| assignees: [] | ||
| description: "Report inconsistencies between TypeScript's DOM typings and browser behavior." |
There was a problem hiding this comment.
I keep being annoyed by usage of DOM in TypeScript, it's really a legacy name that nobody understands. Would be nicer if we call it "web API" here.
| options: | ||
| - label: "This API is supported in at least two major browsers." | ||
| 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?
Co-authored-by: Holger Jeromin <mailgithub@katur.de>
| options: | ||
| - label: "This API is supported in at least two major browsers." | ||
| validations: | ||
| required: true |
There was a problem hiding this comment.
Nothing mentions @types/web though?
.github/ISSUE_TEMPLATE/config.yml
Outdated
| @@ -0,0 +1,6 @@ | |||
| blank_issues_enabled: true | |||
| issue_templates: | |||
| - name: 🔍 Typings Inconsistency | |||
There was a problem hiding this comment.
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.
|
Done @saschanaz |
Co-authored-by: Kagami Sascha Rosylight <saschanaz@outlook.com>
| @@ -55,7 +55,7 @@ body: | |||
| id: use_latest_typescript_web | |||
| attributes: | |||
| label: "Use the latest @types/web Package" | |||
There was a problem hiding this comment.
No "use" but "have tried". Same for the label, options, and the TS version above.
|
I have fixed it with some issues that I have found @saschanaz |
Co-authored-by: Kagami Sascha Rosylight <saschanaz@outlook.com>
|
Looks good to me, this requires additional review from Microsoft. |
| description: "Paste the TypeScript playground link" | ||
| placeholder: "https://www.typescriptlang.org/play/..." | ||
| validations: | ||
| required: true |
There was a problem hiding this comment.
Are these elements required on purpose? Is the intent that anything outside this specific format should be a blank issue? I can imagine someone reporting a bug without a playground link.
There was a problem hiding this comment.
Yes, this is my intent because we need a playground link to help us reproduce the issue. If you think it shouldn't be required I can do that :)
There was a problem hiding this comment.
If @saschanaz is happy, then I'm happy; I'm just double checking as I haven't read everything that happened over the course of the PR.
There was a problem hiding this comment.
I'm fine with making it not required, sometimes it's about conflict with third party type definitions and that wouldn't be reproducible with playground.
There was a problem hiding this comment.
I have made it optional @jakebailey
|
That looks fine to me! |
|
And thanks @Bashamega, hopefully less issues will reference older lib versions now 🙏🏻 |
You are welcome |
closes #1032