Skip to content

Commit f6c0b64

Browse files
authored
gh: create a bug report issue form + chooser config (#134)
* gh: create a bug report issue template + template chooser config - have gotten a decent number of issues with no reproductions, so finally decided to make that a requirement for bug reports - require a reproduction, environment details from `envinfo`, and an attestation that the issues were searched - also have gotten a number of duplicates, some within an hour of each other no less - in the issue template and in the template chooser, also refer folks to SO for support - since more beginners find themselves using this library, make them more aware that issues are for bug reports and not support requests, which are better suited for SO or consulting / contracts (than for volunteer maintainers to help debug every use-case for free). - add links to SO, SO's MCVE/MRE docs, upstream `signature_pad`, and GitHub's communication docs * also search existing issues and give directions on what to do in case of a closed duplicate issue * backslashes apparently not necessary for single new line
1 parent d3c88ad commit f6c0b64

File tree

2 files changed

+83
-0
lines changed

2 files changed

+83
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Reproducible Bug Report
2+
description: If you found a bug within `react-signature-canvas` itself and have a minimal reproduction of it. For support requests, use StackOverflow.
3+
body:
4+
# larger description of what this template's intended usage is
5+
- type: markdown
6+
attributes:
7+
value: |
8+
This template is to report a reproducible bug within `react-signature-canvas` itself.
9+
10+
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.
11+
12+
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.
13+
14+
Before opening a new issue, please do a [search of existing issues](https://github.com/agilgur5/react-signature-canvas/issues?q=is%3Aissue).
15+
If a relevant open issue exists, you should :+1: upvote it instead.
16+
If a relevant closed issue exists, please follow the directions of the closing comments.
17+
Do not open duplicates of existing issues.
18+
19+
# require that users have searched existing issues
20+
- type: checkboxes
21+
attributes:
22+
label: Have you searched the existing issues?
23+
description: Please search to see if an issue already exists for the problem you encountered
24+
options:
25+
- label: I have searched the existing issues and cannot find my problem
26+
required: true
27+
28+
# require that users provide a minimal reproduction
29+
- type: input
30+
attributes:
31+
label: Provide a link to code that _minimally_ reproduces this bug
32+
description: |
33+
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.
34+
35+
_Skipping this or providing an invalid link may result in your issue being summarily closed._
36+
placeholder: 'https://codesandbox.io/p/sandbox/my-minimal-react-signature-canvas-bug-reproduction'
37+
validations:
38+
required: true
39+
40+
# require that users provide their environment details
41+
- type: textarea
42+
attributes:
43+
label: Provide version numbers for your environment by running the below command
44+
description: npx envinfo --npmPackages react-signature-canvas,react,react-dom,typescript --npmGlobalPackages typescript --binaries --browsers --system os
45+
render: text # render as a ```text code block
46+
# example output to clue in user about what it should look like
47+
placeholder: |
48+
System:
49+
OS: macOS 14.5
50+
Binaries:
51+
Node: 22.14.0 - ~/.local/share/mise/installs/node/22.14.0/bin/node
52+
Yarn: 1.22.19 - /usr/local/bin/yarn
53+
npm: 10.9.2 - ~/.local/share/mise/installs/node/22.14.0/bin/npm
54+
Browsers:
55+
Chrome: 134.0.6998.166
56+
Safari: 17.5
57+
npmPackages:
58+
react: ^19.0.0 => 19.0.0
59+
react-dom: ^19.0.0 => 19.0.0
60+
react-signature-canvas: ^1.0.7 => 1.0.7
61+
typescript: ^4.6.3 => 4.6.4
62+
validations:
63+
required: true
64+
65+
# describe the problem
66+
- type: textarea
67+
attributes:
68+
label: Describe the problem, how to reproduce it, and why you believe the behavior is a bug in this library
69+
description: What is the current behavior vs. the expected behavior?
70+
render: markdown # render directly as markdown
71+
# example output to clue in user about what it should look like
72+
placeholder: |
73+
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'`.
74+
As this library is natively written in TypeScript, I assumed that type declarations should be provided and that a TS build would succeed.
75+
validations:
76+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: Search on StackOverflow
3+
url: https://stackoverflow.com/search?q=react-signature-canvas
4+
about: Use StackOverflow for support questions. Issues are for reproducible bug reports and feature requests.
5+
- name: Upstream `signature_pad`'s issues
6+
url: https://github.com/szimek/signature_pad/issues
7+
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.

0 commit comments

Comments
 (0)