Skip to content

Commit

Permalink
github: use envinfo for getting versions in issue reports (#820)
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
agilgur5 authored Aug 23, 2020
1 parent fff9a43 commit 349f299
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,14 @@ assignees: ''

### Your environment

<!-- PLEASE FILL THIS OUT -->

| Software | Version(s) |
| ---------------- | ---------- |
| TSDX |
| TypeScript |
| Browser |
| npm/Yarn |
| Node |
| Operating System |
<!--
PLEASE RUN THIS COMMAND INSIDE YOUR PROJECT:
npx envinfo --system OS --browsers --binaries --npmPackages tsdx,typescript --npmGlobalPackages tsdx,typescript
AND PASTE ITS CONTENTS BELOW INSIDE THE CODE SNIPPET vvvvvvvvv
-->

```text
```

1 comment on commit 349f299

@vercel
Copy link

@vercel vercel bot commented on 349f299 Aug 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.