Skip to content

Commit

Permalink
chore(template): adjust bug report template to include screenshot and…
Browse files Browse the repository at this point in the history
… WIP sections (#2899)

* Update bug-report.yaml

* Update bug-report.yaml

* Update feature-request.yaml

* Create work-in-progress.yaml
  • Loading branch information
carlosrcoelho committed Jul 24, 2024
1 parent 544e763 commit 0ac67a9
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 8 deletions.
16 changes: 10 additions & 6 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,16 @@ body:
- "3.11"
- "3.10"

- type: markdown
- type: textarea
id: screenshot
attributes:
value: |
Screenshot error - If applicable, add screenshots to help explain your problem.
label: Screenshot
description: "If applicable, add screenshots to help explain your problem."
placeholder: "Paste your screenshot here."

- type: markdown
- type: textarea
id: flow-file
attributes:
value: |
Flow file - Add your flow if applicable to help replicate the problem.
label: Flow File
description: "Add your flow if applicable to help replicate the problem."
placeholder: "Add your flow link here."
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ body:
- type: textarea
id: contribution
validations:
required: true
attributes:
label: Your Contribution
description: |
Expand Down
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/work-in-progress.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Work in Progress
description: Use this template to describe the new feature or improvement you are currently working on.
labels: [enhancement]

body:
- type: markdown
attributes:
value: |
## Work in Progress
Thank you for contributing to our project! Please fill out the sections below to describe the new feature or improvement you are currently working on.
- type: input
id: title
attributes:
label: Title
description: Provide a concise title for your feature or improvement.
placeholder: "Short and descriptive title"
validations:
required: true

- type: dropdown
id: type
attributes:
label: Type
description: Is this a new feature or an improvement?
options:
- New Feature
- Improvement
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Provide a detailed description of the feature or improvement.
placeholder: "Explain the feature or improvement in detail"
validations:
required: true

- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe the use case or user story that this feature or improvement addresses.
placeholder: "As a [user], I want to [do something] so that [benefit]."
validations:
required: false

- type: textarea
id: implementation
attributes:
label: Implementation Plan
description: Outline your plan for implementing this feature or improvement.
placeholder: "Describe how you plan to implement this feature or improvement."
validations:
required: false

0 comments on commit 0ac67a9

Please sign in to comment.