-
-
Notifications
You must be signed in to change notification settings - Fork 123
gh: create a bug report issue form + chooser config #134
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,74 @@ | ||||||
name: Reproducible Bug Report | ||||||
description: If you found a bug within `react-signature-canvas` itself and have a minimal reproduction of it. For support requests, use StackOverflow. | ||||||
body: | ||||||
# larger description of what this template's intended usage is | ||||||
- type: markdown | ||||||
attributes: | ||||||
value: | | ||||||
This template is to report a reproducible bug within `react-signature-canvas` itself. | ||||||
|
||||||
Issues [should _not_](https://docs.github.com/en/get-started/using-github/communicating-on-github) be used for support requests -- use [StackOverflow](https://stackoverflow.com/search?q=react-signature-canvas) for that instead. | ||||||
|
||||||
This should _not_ be used for issues with the underlying `signature_pad` -- use [`signature_pad`'s issues](https://github.com/szimek/signature_pad/issues) for that instead. | ||||||
|
||||||
Before opening a new issue, please do a [search of existing issues](https://github.com/agilgur5/react-signature-canvas/issues) and :+1: upvote any existing relevant issues instead. | ||||||
agilgur5 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
Do not open duplicates of existing issues. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Add italics like the other "not"s |
||||||
|
||||||
# require that users have searched existing issues | ||||||
- type: checkboxes | ||||||
attributes: | ||||||
label: Have you searched the existing issues? | ||||||
description: Please search to see if an issue already exists for the problem you encountered | ||||||
options: | ||||||
- label: I have searched the existing issues and cannot find my problem | ||||||
required: true | ||||||
|
||||||
# require that users provide a minimal reproduction | ||||||
- type: input | ||||||
attributes: | ||||||
label: Provide a link to code that _minimally_ reproduces this bug | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also the |
||||||
description: | | ||||||
Link to a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) via a public [CodeSandbox](https://codesandbox.io/s/github/agilgur5/react-signature-canvas/tree/codesandbox-example), StackBlitz project, or GitHub repository. | ||||||
|
||||||
_Skipping this or providing an invalid link may result in your issue being summarily closed._ | ||||||
placeholder: 'https://codesandbox.io/p/sandbox/my-minimal-react-signature-canvas-bug-reproduction' | ||||||
validations: | ||||||
required: true | ||||||
|
||||||
# require that users provide their environment details | ||||||
- type: textarea | ||||||
attributes: | ||||||
label: Provide version numbers for your environment by running the below command | ||||||
description: npx envinfo --npmPackages react-signature-canvas,react,react-dom,typescript --npmGlobalPackages typescript --binaries --browsers --system os | ||||||
render: text # render as a ```text code block | ||||||
# example output to clue in user about what it should look like | ||||||
placeholder: | | ||||||
System: | ||||||
OS: macOS 14.5 | ||||||
Binaries: | ||||||
Node: 22.14.0 - ~/.local/share/mise/installs/node/22.14.0/bin/node | ||||||
Yarn: 1.22.19 - /usr/local/bin/yarn | ||||||
npm: 10.9.2 - ~/.local/share/mise/installs/node/22.14.0/bin/npm | ||||||
Browsers: | ||||||
Chrome: 134.0.6998.166 | ||||||
Safari: 17.5 | ||||||
npmPackages: | ||||||
react: ^19.0.0 => 19.0.0 | ||||||
react-dom: ^19.0.0 => 19.0.0 | ||||||
react-signature-canvas: ^1.0.7 => 1.0.7 | ||||||
typescript: ^4.6.3 => 4.6.4 | ||||||
validations: | ||||||
required: true | ||||||
|
||||||
# describe the problem | ||||||
- type: textarea | ||||||
attributes: | ||||||
label: Describe the problem, how to reproduce it, and why you believe the behavior is a bug in this library | ||||||
description: What is the current behavior vs. the expected behavior? | ||||||
render: markdown # render directly as markdown | ||||||
# example output to clue in user about what it should look like | ||||||
placeholder: | | ||||||
In the provided reproduction, run `npm run typecheck`. This results in a TypeScript error: `Could not find a declaration file for module 'react-signature-canvas'`. | ||||||
As this library is natively written in TypeScript, I assumed that type declarations should be provided and that a TS build would succeed. | ||||||
validations: | ||||||
required: true |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
contact_links: | ||
- name: Search on StackOverflow | ||
url: https://stackoverflow.com/search?q=react-signature-canvas | ||
about: Use StackOverflow for support questions. Issues are for reproducible bug reports and feature requests. | ||
- name: Upstream `signature_pad`'s issues | ||
url: https://github.com/szimek/signature_pad/issues | ||
about: This library is a wrapper around `signature_pad`. If you have an with `signature_pad` itself (as opposed to this wrapper), please see its issue tracker. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same for the markdown here, see above screenshot |
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.
the markdown here renders raw unfortunately:
