Skip to content

Commit 4d58036

Browse files
authored
docs: update issues template (#3406)
1 parent da6742d commit 4d58036

File tree

5 files changed

+132
-55
lines changed

5 files changed

+132
-55
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: '🐛 Bug Report'
2+
description: Create a new ticket for a bug.
3+
title: 'fix: <title>'
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Provide a general summary of the issue in the Title above
10+
- type: textarea
11+
id: expected-behavior
12+
attributes:
13+
label: 'Expected Behavior'
14+
description: Tell us what should happen
15+
placeholder: Short and explicit description of your incident...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: current-behavior
20+
attributes:
21+
label: 'Current Behavior'
22+
description: Tell us what happens instead of the expected behavior
23+
validations:
24+
required: false
25+
- type: checkboxes
26+
id: affected-packages
27+
attributes:
28+
label: 'Affected packages'
29+
options:
30+
- label: cli
31+
- label: core
32+
- label: prompt
33+
- label: config-angular
34+
- type: textarea
35+
id: possible-solution
36+
attributes:
37+
label: 'Possible Solution'
38+
description: Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change
39+
validations:
40+
required: false
41+
- type: textarea
42+
id: steps-to-reproduce
43+
attributes:
44+
label: 'Steps to Reproduce'
45+
description: Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant
46+
value: |
47+
1. First step
48+
2. Second step
49+
render: bash
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: context
54+
attributes:
55+
label: 'Context'
56+
description: |
57+
How has this issue affected you? What are you trying to accomplish?
58+
Providing context helps us come up with a solution that is most useful in the real world
59+
validations:
60+
required: false
61+
- type: input
62+
id: commitlint-version
63+
attributes:
64+
label: 'commitlint --version'
65+
placeholder: '@commitlint/[email protected]'
66+
validations:
67+
required: true
68+
- type: input
69+
id: git-version
70+
attributes:
71+
label: 'git --version'
72+
placeholder: vx.x.x
73+
validations:
74+
required: true
75+
- type: input
76+
id: node-version
77+
attributes:
78+
label: 'node --version'
79+
placeholder: vx.x.x
80+
validations:
81+
required: true
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: '✨ Feature Request'
2+
description: Create a new ticket for a new feature request
3+
title: 'feat: <title>'
4+
labels: ['feature']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Provide a general summary of the issue in the Title above
10+
- type: textarea
11+
id: expected-behavior
12+
attributes:
13+
label: 'Expected Behavior'
14+
description: Tell us how it should work
15+
placeholder: Short and explicit description of your request...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: current-behavior
20+
attributes:
21+
label: 'Current Behavior'
22+
description: Explain the difference from current behavior
23+
validations:
24+
required: false
25+
- type: checkboxes
26+
id: affected-packages
27+
attributes:
28+
label: 'Affected packages'
29+
options:
30+
- label: cli
31+
- label: core
32+
- label: prompt
33+
- label: config-angular
34+
- type: textarea
35+
id: possible-solution
36+
attributes:
37+
label: 'Possible Solution'
38+
description: Ideas how to implement the addition or change
39+
validations:
40+
required: false
41+
- type: textarea
42+
id: context
43+
attributes:
44+
label: 'Context'
45+
description: |
46+
How has this issue affected you? What are you trying to accomplish?
47+
Providing context helps us come up with a solution that is most useful in the real world
48+
validations:
49+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

@packages/test/src/index.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ test('expect to create tmp from directory from src', async () => {
2727
expect(directory).toContain(os.tmpdir());
2828
expect(fs.existsSync(directory)).toBeTruthy();
2929

30-
const indexFile = path.join(directory, 'ISSUE_TEMPLATE.md');
30+
const indexFile = path.join(directory, 'PULL_REQUEST_TEMPLATE.md');
3131
expect(fs.existsSync(indexFile)).toBeTruthy();
3232
});

0 commit comments

Comments
 (0)