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

update issue templates #254

Merged
merged 2 commits into from
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Bug Template
about: Report a bug from a developer or end user
title: "[bug] <title>"
labels: [bug, medium]
---

## Before you proceed

- Check if this is already reported in another issue
- Leave a comment on the issue if there is information missing or you have a question

## Describe the issue in detail

- Add step-by-step repro instructions
- Add information about your environment: OS, browser, browser version, Connect package version
- Add information about your toolchain: package manager, package bundler
- If possible, add a screenshot of the issue, raw debug output, and/or a screenshot of the console log

## What is the expected/desired behavior
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: 🐞 Feature Request
sebastianscatularo marked this conversation as resolved.
Show resolved Hide resolved
description: File a feature request
title: "[feat] <title>"
labels: [enhancement, low]
body:
- type: textarea
attributes:
label: Scenario
description: A brief description of the requirement.
placeholder: |
User Story: As a [Role], I want [Feature] so that [Reason]
> As a User, I want to connect my wallet so that I can transfer my assets.

Job Story: When [Situation], I want [Motivation] so that [Expected Outcome]
> When I have a wallet connected, I want to be able to transfer my assets to another chain so that I can use them in other applications.

Problem Story: In order to [Solve Problem], we will [Build Solution]
> In order to allow users to transfer their assets to other chains, we will build a bridge that will allow them to do so.

System Story: [Action Verb] [Subject] So that [Who] gets [What] or [Goal] is achieved.
> Connect Wallet So that User gets access to their assets.

Improvement Story: We have [Current Situation], we want to have [Desired Situation]
> We have a bridge that allows users to transfer their assets to other chains, we want to have a bridge that allows users to transfer their assets to other chains and also allows them to swap their assets.

Feature Story: [Action] the [Result] [by/for/of/to/in] [Object]
> Transfer the assets by using the bridge.
render: markdown

- type: textarea
attributes:
label: Acceptance Criteria
description: A concise description of what are your expectations.
placeholder: |
- [ ] Given that the user has a wallet connected When the user clicks on the transfer button Then the user should be able to transfer their assets
- [ ] Given that the user has a wallet connected When the user clicks on the swap button Then the user should be able to swap their assets
- [ ] Given that the user has a wallet connected When the user clicks on the transfer button Then the user should be able to transfer their assets

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 🐞 Development Support Request
description: File a development support request
title: "[BUG][DSR] <title>"
labels: [bug, needs triage, medium]
name: 🐞 Support Request
sebastianscatularo marked this conversation as resolved.
Show resolved Hide resolved
description: File a support request
title: "[support] <title>"
labels: [needs triage, medium, wormhole-support]
body:
- type: checkboxes
attributes:
Expand All @@ -13,9 +13,9 @@ body:
- type: checkboxes
attributes:
label: have you checked our wiki for common solutions?
description: Please take a look to our [wiki page](../wiki) to see if we already have a **how to** to help you.
description: Please take a look to our [wiki page](../wiki) or [docs](https://portalbridge.com/docs) to see if we already have a **how to** to help you.
options:
- label: I have searched the wiki
- label: I have searched the wiki or docs
required: true
- type: textarea
attributes:
Expand Down