aboutsummaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug_report.yml
blob: 3390eaee8ecc6c4d9e7ae50b3c2996cbd2ff5b71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
name: "\U0001F41E Bug report"
description: Report an issue
labels: ['s: pending triage', 'c: bug']
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!

        If you are unsure whether your problem is a bug or not, you can check the following:

        - use our [Discord community](https://chat.fakerjs.dev)
        - open a new [discussion](https://github.com/faker-js/faker/discussions) and ask your question there
        - use [StackOverflow using the tag `faker-js`](https://stackoverflow.com/questions/tagged/faker-js)

  - type: checkboxes
    id: checkboxes
    attributes:
      label: Pre-Checks
      description: Before submitting the issue, please make sure you do the following
      options:
        - label: Follow our [Code of Conduct](https://github.com/faker-js/faker/blob/next/CODE_OF_CONDUCT.md).
          required: true
        - label: Read the [Contributing Guidelines](https://github.com/faker-js/faker/blob/next/CONTRIBUTING.md).
          required: true
        - label: Read the [docs](https://fakerjs.dev/guide).
          required: true
        - label: Check that there isn't [already an issue](https://github.com/faker-js/faker/issues) that reports the same bug to avoid creating a duplicate.
          required: true
        - label: Make sure this is a Faker issue and not related to a combination with another package.
          required: true
        - label: Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/faker-js/faker/discussions) or join our [Discord Chat Server](https://chat.fakerjs.dev).
          required: true
        - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
          required: true
        - label: I am willing to provide a PR.

  - type: textarea
    id: bug-description
    attributes:
      label: Describe the bug
      description: A clear and concise description of what the bug is.
      placeholder: I am doing ... What I expect is ... What actually happening is ...
    validations:
      required: true

  - type: textarea
    id: reproduction
    attributes:
      label: Minimal reproduction code
      description: |
        An URL to some git repository or gist that reproduces this issue. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction)
        You can also provide a [Faker StackBlitz workspace](https://fakerjs.dev/new) with a reproduction.
        Alternatively you could write the code sample directly here with [markdown support.](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)
      placeholder: 'https://github.com/..., https://fakerjs.dev/new or ``` code ```'

  - type: textarea
    id: additional-context
    attributes:
      label: Additional Context
      description: |
        Anything else relevant? Please tell us here if you run Faker in a Web Browser.
        **Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in.

  - type: textarea
    id: environment-info
    attributes:
      label: Environment Info
      description: Output of `npx envinfo --system --npmPackages '@faker-js/*' --binaries --browsers`
      render: shell
      placeholder: |
        System:
          OS: _
          CPU: _
          Memory: _ / _
          Container: Yes/No
          Shell: _
        Binaries:
          Node: _ - /usr/bin/node
          Yarn: _ - /usr/bin/yarn
          npm: _ - /usr/bin/npm
        npmPackages:
          @faker-js/faker: _ => _
    validations:
      required: true

  - type: checkboxes
    id: module-system
    attributes:
      label: Which module system do you use?
      options:
        - label: CJS
        - label: ESM

  - type: dropdown
    id: package-manager
    attributes:
      label: Used Package Manager
      description: Select the used package manager
      options:
        - npm
        - yarn
        - pnpm
        - other
    validations:
      required: true