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

Improve issue templates #213

Merged
merged 2 commits into from
Sep 20, 2023
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
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Reporting a Problem/Bug
title: "[<TOOL NAME>] <TITLE>"
description: Reporting a Problem/Bug
labels: [Bug, Feedback]
assignees: onflow/cadence
body:
- type: markdown
attributes:
value: |
> **Warning**
> Do you experience a **crash** in Cadence?
> Please do **NOT** report a crasher as a bug!
>
> Instead, report it as a security issue:
> https://flow.com/flow-responsible-disclosure
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Please share any details and steps that can reproduce the problem
placeholder: |
1. When running a transaction with the following code...
2. See error...
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
Example:
- **Cadence version**: v0.31.2
- **Network**: Emulator
value: |
- Cadence version:
- Network:
render: markdown
validations:
required: true
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Requesting a Feature or Improvement
title: "[<TOOL NAME>] <TITLE>"
description: For feature requests. Please search for existing issues first. Also see CONTRIBUTING.
labels: [Feature, Feedback]
assignees: onflow/cadence
body:
- type: markdown
attributes:
value: |
Please fill out the template below to the best of your ability.
- type: textarea
attributes:
label: Issue to be solved
description: |
Please present a concise description of the problem to be addressed by this feature request.
Please be clear what parts of the problem are considered to be in-scope and out-of-scope.
validations:
required: true
- type: textarea
attributes:
label: Suggested Solution
description: |
A concise description of your preferred solution. Things to address include:
* Details of the technical implementation
* Tradeoffs made in design decisions
* Caveats and considerations for the future

If there are multiple solutions, please present each one separately. Save comparisons for the very end.
validations:
required: false
Loading