Skip to content

Update bug/feature templates #2041

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.

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

Merged
merged 4 commits into from
Dec 19, 2024
Merged

Update bug/feature templates #2041

merged 4 commits into from
Dec 19, 2024

Conversation

drwpow
Copy link
Contributor

@drwpow drwpow commented Dec 4, 2024

Changes

Updates our bug/feature issue templates to use the new form format with validations! Also adds templates for openapi-react-query and swr-openapi

How to Review

  • Some of the descriptions are the same across the templates. Would it be helpful for some of the libraries to get unique questions?

Checklist

N/A

@drwpow drwpow requested a review from a team as a code owner December 4, 2024 17:18
@drwpow drwpow requested a review from gzm0 December 4, 2024 17:18
Copy link

changeset-bot bot commented Dec 4, 2024

⚠️ No Changeset found

Latest commit: 1aa7215

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Dec 4, 2024

size-limit report 📦

Path Size
packages/openapi-fetch/dist/index.min.js 6.42 KB (0%)

@@ -0,0 +1,42 @@
---
name: "Bug report: swr-openapi"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@htunnicliff Any changes/unique questions you’d like to ask for swr-openapi? (Ditto for feature requests)?

@@ -0,0 +1,30 @@
---
name: "Feature request: openapi-react-query"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kerwanp Any unique descriptions / questions you’d like to add for openapi-react-query? (Same for feature request)?

about: For the openapi-fetch library
title: ""
labels: openapi-fetch, bug
assignees: ""
Copy link
Contributor Author

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.

Copy link
Contributor

@gzm0 gzm0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a nice modernization. I've left some comments (some of them apply to all templates, I just left them once).

RE the "code of conduct" checkbox. Do you feel there is a lot of value in having explicit acknowledgment of the code of conduct? (it's not like adhering to it is optional either way, but enforcement might be helped by an explicit ack).

Comment on lines +20 to +25
- type: input
attributes:
label: OS + version
placeholder: macOS 15.1.1
validations:
required: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we see OS specific issues a lot? (then a gain, it's little to ask, so maybe better to ask right away).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything that talks to the filesystem, really, it’s important to know what OS they’re on.

Ah, yes, good point!

options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/openapi-ts/openapi-typescript/blob/main/CODE_OF_CONDUCT.md)
required: true
- label: My OpenAPI schema is valid and passes the [Redocly validator](https://redocly.com/docs/cli/commands/lint/) (`npx @redocly/cli@latest lint`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link

cloudflare-workers-and-pages bot commented Dec 19, 2024

Deploying openapi-ts with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1aa7215
Status: ✅  Deploy successful!
Preview URL: https://3d45b89b.openapi-ts.pages.dev
Branch Preview URL: https://update-templates.openapi-ts.pages.dev

View logs

@drwpow drwpow merged commit e7e1554 into main Dec 19, 2024
10 checks passed
@drwpow drwpow deleted the update-templates branch December 19, 2024 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants