github: use envinfo for getting versions in issue reports #820
Conversation
This file contains 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
- replace the version table with a copy+paste this `envinfo` command,
copy back the output
- saw `nyc` using this about a year ago and thought it was super
useful; finally got around to adding it here
- https://github.com/istanbuljs/nyc/blame/00c3b3440a5b2ffe11b9c19ae4e08ad2f5b70e33/.github/ISSUE_TEMPLATE.md#L20-L23
- exact language was modified and updated from
https://github.com/styled-components/styled-components/blame/53bc31f/.github/ISSUE_TEMPLATE.md#L34
as TSDX does not have its own envinfo preset
- perhaps worth creating one?
- code snippet inspired from
https://github.com/facebook/jest/blame/4d32070/.github/ISSUE_TEMPLATE/bug.md#L35
- this should make reporting versions zero-effort and thereby
significantly decrease non-reporting by making the hard thing easy
- have had a few places that didn't report and version was *very*
relevant to the issue
- also have had several that reported "latest" or used carets, which
lacks posterity or is confusing
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/formium/tsdx/bx7p9ouwj |
agilgur5
commented
Aug 23, 2020
paul-vd
pushed a commit
to EezyQuote/tsdx
that referenced
this pull request
Dec 1, 2020
…r#820) - replace the version table with a copy+paste this `envinfo` command, copy back the output - saw `nyc` using this about a year ago and thought it was super useful; finally got around to adding it here - https://github.com/istanbuljs/nyc/blame/00c3b3440a5b2ffe11b9c19ae4e08ad2f5b70e33/.github/ISSUE_TEMPLATE.md#L20-L23 - exact language was modified and updated from https://github.com/styled-components/styled-components/blame/53bc31f/.github/ISSUE_TEMPLATE.md#L34 as TSDX does not have its own envinfo preset - perhaps worth creating one? - code snippet inspired from https://github.com/facebook/jest/blame/4d32070/.github/ISSUE_TEMPLATE/bug.md#L35 - this should make reporting versions zero-effort and thereby significantly decrease non-reporting by making the hard thing easy - have had a few places that didn't report and version was *very* relevant to the issue - also have had several that reported "latest" or used carets, which lacks posterity or is confusing
1 task
1 task
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.
Description
replace the version table with a copy+paste this
envinfocommand,copy back the output
nycusing this about a year ago and thought it was superuseful; finally got around to adding it here
https://github.com/styled-components/styled-components/blame/53bc31f/.github/ISSUE_TEMPLATE.md#L34
as TSDX does not have its own envinfo preset
https://github.com/facebook/jest/blame/4d32070/.github/ISSUE_TEMPLATE/bug.md#L35
this should make reporting versions zero-effort and thereby
significantly decrease non-reporting by making the hard thing easy
relevant to the issue
lacks posterity or is confusing
Tags
I actually suggested using this myself in #167, which was one of my first issues here