diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 05a7b16e0b..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,54 +0,0 @@ - - -## Expected Behavior - - - - -## Current Behavior - - - - -## Affected packages - -- [ ] cli -- [ ] core -- [ ] prompt -- [ ] config-angular - -## Possible Solution - - - - -## Steps to Reproduce (for bugs) - - - - -1. First step -2. Second step - -
- commitlint.config.js - - -```js -``` -
- -## Context - - - - -## Your Environment - - - -| Executable | Version | -| ---------------------: | :------ | -| `commitlint --version` | VERSION | -| `git --version` | VERSION | -| `node --version` | VERSION | diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 0000000000..2ab9c36039 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,81 @@ +name: '🐛 Bug Report' +description: Create a new ticket for a bug. +title: 'fix: ' +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 diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml new file mode 100644 index 0000000000..bf4e9609df --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..0086358db1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/@packages/test/src/index.test.ts b/@packages/test/src/index.test.ts index 1865e8b1e6..229ee8af0b 100644 --- a/@packages/test/src/index.test.ts +++ b/@packages/test/src/index.test.ts @@ -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(); });