Skip to content

Commit

Permalink
docs: update issues template (#3406)
Browse files Browse the repository at this point in the history
  • Loading branch information
FelixLgr committed Oct 31, 2022
1 parent da6742d commit 4d58036
Show file tree
Hide file tree
Showing 5 changed files with 132 additions and 55 deletions.
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: '🐛 Bug Report'
description: Create a new ticket for a bug.
title: 'fix: <title>'
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Provide a general summary of the issue in the Title above
- type: textarea
id: expected-behavior
attributes:
label: 'Expected Behavior'
description: Tell us what should happen
placeholder: Short and explicit description of your incident...
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: 'Current Behavior'
description: Tell us what happens instead of the expected behavior
validations:
required: false
- type: checkboxes
id: affected-packages
attributes:
label: 'Affected packages'
options:
- label: cli
- label: core
- label: prompt
- label: config-angular
- type: textarea
id: possible-solution
attributes:
label: 'Possible Solution'
description: Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change
validations:
required: false
- type: textarea
id: steps-to-reproduce
attributes:
label: 'Steps to Reproduce'
description: Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant
value: |
1. First step
2. Second step
render: bash
validations:
required: true
- type: textarea
id: context
attributes:
label: 'Context'
description: |
How has this issue affected you? What are you trying to accomplish?
Providing context helps us come up with a solution that is most useful in the real world
validations:
required: false
- type: input
id: commitlint-version
attributes:
label: 'commitlint --version'
placeholder: '@commitlint/cli@x.x.x'
validations:
required: true
- type: input
id: git-version
attributes:
label: 'git --version'
placeholder: vx.x.x
validations:
required: true
- type: input
id: node-version
attributes:
label: 'node --version'
placeholder: vx.x.x
validations:
required: true
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: '✨ Feature Request'
description: Create a new ticket for a new feature request
title: 'feat: <title>'
labels: ['feature']
body:
- type: markdown
attributes:
value: |
Provide a general summary of the issue in the Title above
- type: textarea
id: expected-behavior
attributes:
label: 'Expected Behavior'
description: Tell us how it should work
placeholder: Short and explicit description of your request...
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: 'Current Behavior'
description: Explain the difference from current behavior
validations:
required: false
- type: checkboxes
id: affected-packages
attributes:
label: 'Affected packages'
options:
- label: cli
- label: core
- label: prompt
- label: config-angular
- type: textarea
id: possible-solution
attributes:
label: 'Possible Solution'
description: Ideas how to implement the addition or change
validations:
required: false
- type: textarea
id: context
attributes:
label: 'Context'
description: |
How has this issue affected you? What are you trying to accomplish?
Providing context helps us come up with a solution that is most useful in the real world
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
2 changes: 1 addition & 1 deletion @packages/test/src/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ test('expect to create tmp from directory from src', async () => {
expect(directory).toContain(os.tmpdir());
expect(fs.existsSync(directory)).toBeTruthy();

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

0 comments on commit 4d58036

Please sign in to comment.