Skip to content

Commit

Permalink
chore: improve issue templates (#2738)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielbate authored Jul 23, 2024
1 parent d4c4e55 commit 1013aca
Show file tree
Hide file tree
Showing 6 changed files with 90 additions and 62 deletions.
4 changes: 4 additions & 0 deletions .changeset/honest-onions-vanish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

chore: update issue templates
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Bug Report
description: Open an issue for a problem you've identified with `fuels`.
labels: ["triage"]
body:
- type: markdown
attributes:
value: |
Thank you for helping to improve our Typescript SDK!
Before submitting an issue, please ensure you are using the latest version of the SDK, as well as `forc` and `fuel-core`. Additionally, search through the [documentation](https://docs.fuel.network/docs/fuels-ts/) or on our [forum](https://forum.fuel.network/c/typescript-sdk) as it's possible your problem has already been solved there.
Failing that, please submit an issue using the form below.
- type: input
attributes:
label: fuels-ts SDK Version
description: What version of `fuels` are you using? Before opening an issue, please make sure you are up to date.
placeholder: e.g. [email protected]
validations:
required: true
- type: input
attributes:
label: Toolchain Versions
description: Please share the result of running `fuelup show` in your terminal.
validations:
required: true
- type: input
attributes:
label: Node.js Version
description: Specify the version of Node.js you are using.
placeholder: e.g. Node.js v22.0.0
- type: input
attributes:
label: Browser
description: Specify the browser and version you are using.
placeholder: e.g. Chrome v5
- type: input
attributes:
label: Operating System
description: Specify your operating system and version.
placeholder: e.g. macOS 11.2, Windows 10
- type: textarea
attributes:
label: Describe the Problem
description: Please describe what you expected to happen vs what did happen? Please include steps to reproduce the problem.
validations:
required: true
- type: textarea
attributes:
label: Code Snippet
description: If possible, please include a **short and concise** code snippet that can reproduce this issue. Or even better, please share a link to a repo or gist with a minimal reproduction of the problem.
render: shell
- type: textarea
attributes:
label: Contract ABI
description: If this involves a contract, please include any **concise and relevant** ABI fragments.
render: shell
- type: textarea
id: errors
attributes:
label: Errors
description: If there is an error, please include the **entire error** (redacting any sensitive information).
render: shell
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Feature Request
description: Suggest a new feature for `fuels`.
labels: ["triage"]
body:
- type: markdown
attributes:
value: |
Thank you for helping to improve our Typescript SDK!
The best place to submit a feature request is in a [discussion](https://github.com/FuelLabs/fuels-ts/discussions/new?category=ideas). This gives you the opportunity to present the idea to the community, discuss potential solutions and their impacts before submitting the proposed solution as a feature request.
Failing that, please submit a feature request using the form below.
- type: textarea
attributes:
label: Describe the Feature
description: Please describe the feature and the problem it is solving. As well as your proposed solution and if possible, other alternatives.
validations:
required: true
- type: textarea
attributes:
label: Code Example
description: Optionally, provide an example of how the feature would be used in code.
render: shell
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug.yaml

This file was deleted.

1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/feature.yaml

This file was deleted.

0 comments on commit 1013aca

Please sign in to comment.