Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: new issue form templates #149 #213

Merged
merged 1 commit into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/backlog-ticket.md

This file was deleted.

67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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.
42 changes: 0 additions & 42 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

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: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.yml
Original file line number Diff line number Diff line change
@@ -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.
Loading