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

feat: add pitch issue template #698

Merged
merged 6 commits into from
Jul 11, 2023
Merged
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
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/pitch.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Pitch
description: 'Do you have an idea and a product enhancement? Time to pitch!'
title: '[PITCH]:'
labels: ['Pitch']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this pitch! If you need some inspiration, you can check out these pitch examples: [Example 1](https://github.com/asyncapi/studio/issues/636) and [Example 2](https://github.com/asyncapi/studio/issues/703).
- type: textarea
id: problem
attributes:
label: Problem
description: "Please provide a detailed description of the problem that users are facing. Share the story or context that exposes the problem."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution
description: "Describe your proposed solution to address the problem. You can include examples, mockups, or views to illustrate your solution."
validations:
required: true
- type: textarea
id: rabbit_holes
attributes:
label: Rabbit holes
description: "Identify potential technical, design, or other challenges that might arise during the implementation of the solution. Discuss any anticipated obstacles or complexities."
validations:
required: true
- type: textarea
id: scope
attributes:
label: Scope
description: "Outline a list of tasks or issues that need to be completed to bring the proposed solution to life. You don't need to provide an exhaustive list upfront."
placeholder: |
- [ ] Task 1
- [ ] Task 2
- [ ] Task 3
validations:
required: true
- type: textarea
id: out-of-bounds
attributes:
label: Out of bounds
description: "Specify any elements or features that explicitly fall outside the scope of this pitch. Clarify what won't be included in the solution."
validations:
required: false
- type: textarea
id: success
attributes:
label: Success criteria
description: "Define the criteria that will determine the success of the proposed solution. Specify the specific outcomes or metrics that will indicate the effectiveness of the solution."
validations:
required: false