gh: create a bug report issue form + chooser config #134
+83
−0
Conversation
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
- 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
This comment was marked as resolved.
This comment was marked as resolved.
agilgur5
commented
Apr 12, 2025
and give directions on what to do in case of a closed duplicate issue
agilgur5
commented
Apr 12, 2025
agilgur5
commented
Apr 12, 2025
There was a problem hiding this comment.
- I'm not sure how the top-level description or template chooser in general render exactly as GH does not provide a preview of that. Markdown may not be supported in those
Unpreviewable bits render raw (i.e. markdown is not used as formatting), see in-line comment below with screenshot
- The
attributes.descriptionunfortunately goes under the forminputortextarea(but not forcheckboxes, which is inconsistent 😕 ); there's no way to configure this
Turns out the preview is incorrect/buggy, this correctly renders above the input or textarea after merge:
Screenshot:
| @@ -0,0 +1,76 @@ | |||
| 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. | |||
There was a problem hiding this comment.
the markdown here renders raw unfortunately:
| 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.
same for the markdown here, see above screenshot
agilgur5
commented
Apr 17, 2025
| # 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.
Also the label renders raw as well. This is visible in the preview though, not sure if I missed it or intentionally decided to leave it in for some form of emphasis
agilgur5
commented
Apr 17, 2025
| Before opening a new issue, please do a [search of existing issues](https://github.com/agilgur5/react-signature-canvas/issues?q=is%3Aissue). | ||
| If a relevant open issue exists, you should :+1: upvote it instead. | ||
| If a relevant closed issue exists, please follow the directions of the closing comments. | ||
| Do not open duplicates of existing issues. |
There was a problem hiding this comment.
Suggested change
| Do not open duplicates of existing issues. | |
| _Do not_ open duplicates of existing issues. |
Add italics like the other "not"s
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Create a GH issue form for bug reports and a small template chooser configuration
Details
have gotten a decent number of issues with no reproductions1, so finally decided to make that a requirement for bug reports2
envinfo, and an attestation that the issues were searchedin the issue template and in the template chooser, also refer folks to SO for support
add links to an SO search for
react-signature-canvas, SO's MCVE/MRE docs, upstreamsignature_pad's issue tracker, and GitHub's communication docsNotes to Reviewers
attributes.descriptionunfortunately goes under the forminputortextarea(but not forcheckboxes, which is inconsistent 😕 ); there's no way to configure thisConsiderations / Trade-offs
blank_issues_enabled, but there is no feature request template yet or question template etc. If it gets abused, I will disable it as I have had to do elsewhereVerification
See preview of the bug report form (the chooser is not previewable unfortunately)
Prior Art
Takes inspiration from my prior work with:
rollup-plugin-typescript2: troubleshooting steps (github: add troubleshooting steps to the issue template ezolenko/rollup-plugin-typescript2#350), MRE links (ezolenko/rollup-plugin-typescript2@045560c etc), usingenvinfo(github: use envinfo for getting versions in issue reports ezolenko/rollup-plugin-typescript2#245 etc)And some inspiration from Next.js's bug report form: top-level markdown intro, reproduction link directions
Footnotes
The
problem: no reprolabel and thesolution: can't reprolabel, plus times when a repro was eventually created by me or a user and so the label was removed. Around ~18 in total, which is a significant proportion of issues ↩I also mentioned making an issue template all the way back in https://github.com/agilgur5/react-signature-canvas/issues/38#issuecomment-568366070. Fortunately the deluge of unreproducible issues stopped shortly after that, with a bit of a resurgence recently ↩
The
solution: duplicatelabel, which has a decent amount of overlap with the non-reproducible ones (likely points to low quality issues in general). Around ~18 in total. ↩