Update bug/feature templates #2041
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,39 @@ | ||
| --- | ||
| name: "Bug report: openapi-fetch" | ||
| about: For the openapi-fetch library | ||
| title: "" | ||
| labels: openapi-fetch, bug | ||
| assignees: "" | ||
| body: | ||
| - type: input | ||
| attributes: | ||
| label: Version | ||
| placeholder: x.x.x | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: A brief description of the bug. Provide either a screenshot or the full error message! | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: repro | ||
| attributes: | ||
| label: Reproduction | ||
| description: How can this be reproduced / when did the error occur? Does the issue occur in a specific browser, or all browsers? Bonus points for a GitHub repository link. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Expected result | ||
| description: (In case it’s not obvious) | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-fetch/CONTRIBUTING.md)) | ||
| --- | ||
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,39 @@ | ||
| --- | ||
| name: "Bug report: openapi-react-query" | ||
| about: For the openapi-react-query library | ||
| title: "" | ||
| labels: openapi-react-query, bug | ||
| assignees: "" | ||
| body: | ||
| - type: input | ||
| attributes: | ||
| label: Version | ||
| placeholder: x.x.x | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: A brief description of the bug. Provide either a screenshot or the full error message! | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: repro | ||
| attributes: | ||
| label: Reproduction | ||
| description: How can this be reproduced / when did the error occur? Does the issue occur in a specific browser, or all browsers? Bonus points for a GitHub repository link. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Expected result | ||
| description: (In case it’s not obvious) | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-react-query/CONTRIBUTING.md)) | ||
| --- |
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,53 @@ | ||
| --- | ||
| name: "Bug report: openapi-typescript" | ||
| about: For the openapi-typescript library | ||
| title: "" | ||
| labels: openapi-ts, bug | ||
| assignees: "" | ||
| body: | ||
| - type: input | ||
| attributes: | ||
| label: openapi-typescript version | ||
| placeholder: x.x.x | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Node.js version | ||
| placeholder: 20.x.x | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: OS + version | ||
| placeholder: macOS 15.1.1 | ||
| validations: | ||
| required: true | ||
|
Comment on lines
+20
to
+25
There was a problem hiding this comment. Do we see OS specific issues a lot? (then a gain, it's little to ask, so maybe better to ask right away). There was a problem hiding this comment. Especially with openapi-typescript, quite a lot! It’s also why we have Windows tests. Anything that talks to the filesystem, really, it’s important to know what OS they’re on. Put another way, it’s basically a “are you using Windows” question. There was a problem hiding this comment.
Ah, yes, good point! |
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: A brief description of the bug. Provide either a screenshot or the full error message! | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: repro | ||
| attributes: | ||
| label: Reproduction | ||
| description: How can this be reproduced / when did the error occur? Does the issue occur in a specific browser, or all browsers? Bonus points for a GitHub repository link. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Expected result | ||
| description: (In case it’s not obvious) | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: My OpenAPI schema is valid and passes the [Redocly validator](https://redocly.com/docs/cli/commands/lint/) (`npx @redocly/cli@latest lint`) | ||
|
|
||
| required: true | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/CONTRIBUTING.md)) | ||
| --- | ||
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,39 @@ | ||
| --- | ||
| name: "Bug report: swr-openapi" | ||
|
There was a problem hiding this comment. @htunnicliff Any changes/unique questions you’d like to ask for swr-openapi? (Ditto for feature requests)? |
||
| about: For the swr-openapi library | ||
| title: "" | ||
| labels: swr-openapi, bug | ||
| assignees: "" | ||
| body: | ||
| - type: input | ||
| attributes: | ||
| label: Version | ||
| placeholder: x.x.x | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: A brief description of the bug. Provide either a screenshot or the full error message! | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: repro | ||
| attributes: | ||
| label: Reproduction | ||
| description: How can this be reproduced / when did the error occur? Does the issue occur in a specific browser, or all browsers? Bonus points for a GitHub repository link. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Expected result | ||
| description: (In case it’s not obvious) | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/swr-openapi/CONTRIBUTING.md)) | ||
| --- | ||
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,27 @@ | ||
| --- | ||
| name: "Feature request: openapi-fetch" | ||
| about: For the openapi-fetch library | ||
| title: "" | ||
| labels: openapi-fetch, enhancement, help wanted | ||
| assignees: "" | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Brief description of the problem you’re trying to solve, and why this could be useful. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposal | ||
| description: Describe the proposed syntax change. Please reference any prior art or similar examples. | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-fetch/CONTRIBUTING.md)) | ||
| --- |
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,27 @@ | ||
| --- | ||
| name: "Feature request: openapi-react-query" | ||
|
There was a problem hiding this comment. @kerwanp Any unique descriptions / questions you’d like to add for openapi-react-query? (Same for feature request)? |
||
| about: For the openapi-react-query library | ||
| title: "" | ||
| labels: openapi-react-query, enhancement, help wanted | ||
| assignees: "" | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Brief description of the problem you’re trying to solve, and why this could be useful. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposal | ||
| description: Describe the proposed syntax change. Please reference any prior art or similar examples. | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-react-query/CONTRIBUTING.md)) | ||
| --- | ||
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,27 @@ | ||
| --- | ||
| name: "Feature request: openapi-typescript" | ||
| about: For the openapi-typescript library | ||
| title: "" | ||
| labels: openapi-ts, enhancement, help wanted | ||
| assignees: "" | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Brief description of the problem you’re trying to solve, and why this could be useful. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposal | ||
| description: Outline the change to the library. If this is for the CLI, propose a flag name and/or workflow. If this is for Node API, propose how this would be consumed. Reference any prior art or similar examples. | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/CONTRIBUTING.md)) | ||
| --- |
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,27 @@ | ||
| --- | ||
| name: "Feature request: swr-openapi" | ||
| about: For the swr-openapi library | ||
| title: "" | ||
| labels: swr-openapi, enhancement, help wanted | ||
| assignees: "" | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Brief description of the problem you’re trying to solve, and why this could be useful. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposal | ||
| description: Describe the proposed syntax change. Please reference any prior art or similar examples. | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checklist | ||
| attributes: | ||
| options: | ||
| - label: I’m willing to open a PR (see [CONTRIBUTING.md](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/swr-openapi/CONTRIBUTING.md)) | ||
| --- |
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.
I originally started to see if we could auto-assign to a specific team, but I think we need a custom action to do a round-robin assignment that I’ll add in a followup (assigning to the entire team means we all get notified, and I wanted to find a solution where we don’t all get notified for everything).
But in me examining the templates, I realized these were a little stale and could use some updating.