diff --git a/.github/ISSUE_TEMPLATE/backlog-ticket.md b/.github/ISSUE_TEMPLATE/backlog-ticket.md deleted file mode 100644 index 1d1fab10..00000000 --- a/.github/ISSUE_TEMPLATE/backlog-ticket.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Backlog Ticket -about: New feature/ticket for the project -title: '' -labels: '' -assignees: '' - ---- - -# Overview (What and Why) -{Write description of what the feature should be, why} - -# How -{Describe what needs to be done.} - -- [ ] Task 1 -- [ ] Task 2 - -# Definition of Done -{Write definition of done, how to verify} - -- [ ] Unit test cases (delete if not applicable) -- [ ] Docs updated (delete if not applicable) -- [ ] PR approved and merged to master (delete if not applicable) - -# Open Issues and Blockers -{Dependencies issue or PR or some other blocker.} diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..7524d9ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,67 @@ +name: Bug Report +description: Create a report to help us improve +title: "[BUG]: " +labels: ["bug"] +projects: ["swanky-cli"] + +body: + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Tell us what happened. In particular, tell us how and why you are using this project, and describe the bug that you encountered. Please note that we are not able to support all conceivable use cases, but the more information you are able to provide the more equipped we will be to help. + placeholder: Write your bug report here + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: Replace the example steps below with actual steps to reproduce the bug you're reporting. + value: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: Tell us what should happen + placeholder: Write your expected behavior here. + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: Tell us what happens instead + placeholder: Write your actual behavior here. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Describe the environment in which you encountered this bug. Use the list below as a starting point and add additional information if you think it's relevant. + value: | + - Operating System + - Project version/tag: (run 'swanky version') + - Rust version (run `rustup show`) + - Node version (run `node --version`) + validations: + required: true + - type: textarea + id: logs + attributes: + label: Logs, Errors, Screenshots + description: Please provide the text of any logs or errors that you experienced; if applicable, provide screenshots to help illustrate the problem. + placeholder: | + Paste your logs here + - type: textarea + id: additional-info + attributes: + label: Additional information + description: Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index cf35c2d8..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: '' - ---- - -**Description** - -> Tell us what happened. In particular, tell us how and why you are using this project, and describe the bug that you encountered. Please note that we are not able to support all conceivable use cases, but the more information you are able to provide the more equipped we will be to help. - -**Steps to Reproduce** - -> Replace the example steps below with actual steps to reproduce the bug you're reporting. - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected vs. Actual Behavior** - -> What did you expect to happen after you followed the steps you described in the last section? What actually happened? - -**Environment** - -> Describe the environment in which you encountered this bug. Use the list below as a starting point and add additional information if you think it's relevant. - -- Operating system: -- Project version/tag: (run 'swanky version') -- Rust version (run `rustup show`): -- Node version (run `node --version`) - -**Logs, Errors or Screenshots** - -> Please provide the text of any logs or errors that you experienced; if applicable, provide screenshots to help illustrate the problem. - -**Additional Information** - -> Please add any other details that you think may help us solve your problem. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/new-feature.yml b/.github/ISSUE_TEMPLATE/new-feature.yml new file mode 100644 index 00000000..9759a9cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -0,0 +1,43 @@ +name: Feature request +description: New feature/ticket for the project +labels: ["enhancement"] +projects: ["swanky-cli"] + +body: + - type: textarea + id: overview + attributes: + label: Overview (What and Why) + description: Write description of what the feature should be, why + validations: + required: true + + - type: textarea + id: how + attributes: + label: How to do it? + description: Describe what needs to be done. + placeholder: | + - Task 1 + - Task 2 + validations: + required: true + + - type: textarea + id: definition-of-done + attributes: + label: Definition of Done + description: Write definition of done, how to verify + placeholder: | + - Unit test cases + - Docs updated + - PR approved and merged to master + - etc. + validations: + required: true + + - type: textarea + id: open-issues-and-blockers + attributes: + label: Open Issues and Blockers + description: Dependencies issue or PR or some other blocker.