|
1 | 1 | name: "\U0001F41E Bug report" |
2 | 2 | description: Report an issue |
3 | | -labels: ['s: pending triage'] # This will automatically assign the 's: pending triage' label |
| 3 | +labels: ['s: pending triage', 'c: bug'] |
4 | 4 | body: |
5 | 5 | - type: markdown |
6 | 6 | attributes: |
7 | | - value: Thanks for taking the time to fill out this bug report! |
| 7 | + value: | |
| 8 | + Thanks for taking the time to fill out this bug report! |
| 9 | +
|
| 10 | + If you are unsure whether your problem is a bug or not, you can check the following: |
| 11 | +
|
| 12 | + - use our [Discord community](https://chat.fakerjs.dev) |
| 13 | + - open a new [discussion](https://github.com/faker-js/faker/discussions) and ask your question there |
| 14 | + - use [StackOverflow using the tag `faker-js`](https://stackoverflow.com/questions/tagged/faker-js) |
| 15 | +
|
| 16 | + - type: checkboxes |
| 17 | + id: checkboxes |
| 18 | + attributes: |
| 19 | + label: Pre-Checks |
| 20 | + description: Before submitting the issue, please make sure you do the following |
| 21 | + options: |
| 22 | + - label: Follow our [Code of Conduct](https://github.com/faker-js/faker/blob/main/CODE_OF_CONDUCT.md). |
| 23 | + required: true |
| 24 | + - label: Read the [Contributing Guidelines](https://github.com/faker-js/faker/blob/main/CONTRIBUTING.md). |
| 25 | + required: true |
| 26 | + - label: Read the [docs](https://fakerjs.dev/guide). |
| 27 | + required: true |
| 28 | + - 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. |
| 29 | + required: true |
| 30 | + - label: Make sure this is a Faker issue and not related to a combination with another package. |
| 31 | + required: true |
| 32 | + - 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). |
| 33 | + required: true |
| 34 | + - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. |
| 35 | + required: true |
| 36 | + - label: I am willing to provide a PR. |
| 37 | + |
8 | 38 | - type: textarea |
9 | 39 | id: bug-description |
10 | 40 | attributes: |
11 | 41 | label: Describe the bug |
12 | | - description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! |
13 | | - placeholder: Bug description |
| 42 | + description: A clear and concise description of what the bug is. |
| 43 | + placeholder: I am doing ... What I expect is ... What actually happening is ... |
14 | 44 | validations: |
15 | 45 | required: true |
| 46 | + |
16 | 47 | - type: textarea |
17 | 48 | id: reproduction |
18 | 49 | attributes: |
19 | | - label: Reproduction |
20 | | - description: Please reproduce the problem you ran into. |
21 | | - placeholder: Reproduction |
| 50 | + label: Minimal reproduction code |
| 51 | + description: | |
| 52 | + 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) |
| 53 | + You can also provide a [Faker StackBlitz workspace](https://fakerjs.dev/new) with a reproduction. |
| 54 | + 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) |
| 55 | + placeholder: 'https://github.com/..., https://fakerjs.dev/new or ``` code ```' |
| 56 | + |
| 57 | + - type: textarea |
| 58 | + id: additional-context |
| 59 | + attributes: |
| 60 | + label: Additional Context |
| 61 | + description: | |
| 62 | + Anything else relevant? Please tell us here if you run Faker in a Web Browser. |
| 63 | + **Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in. |
| 64 | +
|
| 65 | + - type: textarea |
| 66 | + id: environment-info |
| 67 | + attributes: |
| 68 | + label: Environment Info |
| 69 | + description: Output of `npx envinfo --system --npmPackages '@faker-js/*' --binaries --browsers` |
| 70 | + render: shell |
| 71 | + placeholder: | |
| 72 | + System: |
| 73 | + OS: _ |
| 74 | + CPU: _ |
| 75 | + Memory: _ / _ |
| 76 | + Container: Yes/No |
| 77 | + Shell: _ |
| 78 | + Binaries: |
| 79 | + Node: _ - /usr/bin/node |
| 80 | + Yarn: _ - /usr/bin/yarn |
| 81 | + npm: _ - /usr/bin/npm |
| 82 | + npmPackages: |
| 83 | + @faker-js/faker: _ => _ |
22 | 84 | validations: |
23 | 85 | required: true |
24 | | - - type: textarea |
25 | | - id: additional-info |
| 86 | + |
| 87 | + - type: checkboxes |
| 88 | + id: module-system |
26 | 89 | attributes: |
27 | | - label: Additional Info |
28 | | - description: Give us additional info like e.g. version numbers. |
29 | | - placeholder: Additional info |
| 90 | + label: Which module system do you use? |
| 91 | + options: |
| 92 | + - label: CJS |
| 93 | + - label: ESM |
| 94 | + |
| 95 | + - type: dropdown |
| 96 | + id: package-manager |
| 97 | + attributes: |
| 98 | + label: Used Package Manager |
| 99 | + description: Select the used package manager |
| 100 | + options: |
| 101 | + - npm |
| 102 | + - yarn |
| 103 | + - pnpm |
| 104 | + - other |
30 | 105 | validations: |
31 | | - required: false |
| 106 | + required: true |
0 commit comments