Skip to content

Commit cf52831

Browse files
committed
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
1 parent d3c88ad commit cf52831

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

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