Skip to content

Commit 349f299

Browse files
authored
github: use envinfo for getting versions in issue reports (#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 parent fff9a43 commit 349f299

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,14 @@ assignees: ''
2525

2626
### Your environment
2727

28-
<!-- PLEASE FILL THIS OUT -->
29-
30-
| Software | Version(s) |
31-
| ---------------- | ---------- |
32-
| TSDX |
33-
| TypeScript |
34-
| Browser |
35-
| npm/Yarn |
36-
| Node |
37-
| Operating System |
28+
<!--
29+
PLEASE RUN THIS COMMAND INSIDE YOUR PROJECT:
30+
31+
npx envinfo --system OS --browsers --binaries --npmPackages tsdx,typescript --npmGlobalPackages tsdx,typescript
32+
33+
AND PASTE ITS CONTENTS BELOW INSIDE THE CODE SNIPPET vvvvvvvvv
34+
-->
35+
36+
```text
37+
38+
```

0 commit comments

Comments
 (0)