diff --git a/.changeset/honest-onions-vanish.md b/.changeset/honest-onions-vanish.md new file mode 100644 index 0000000000..d189501543 --- /dev/null +++ b/.changeset/honest-onions-vanish.md @@ -0,0 +1,4 @@ +--- +--- + +chore: update issue templates diff --git a/.github/ISSUE_TEMPLATE/1-bug.yaml b/.github/ISSUE_TEMPLATE/1-bug.yaml new file mode 100644 index 0000000000..97a5b5fd0a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.yaml @@ -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. fuels@x.y.z + 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 diff --git a/.github/ISSUE_TEMPLATE/2-feature.yaml b/.github/ISSUE_TEMPLATE/2-feature.yaml new file mode 100644 index 0000000000..ada51545c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml deleted file mode 100644 index 9192fd731d..0000000000 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ /dev/null @@ -1,44 +0,0 @@ -name: 🐛 Bug Report -description: Something is wrong with fuels-ts. -labels: ["bug", "triage"] -body: - - type: markdown - attributes: - value: | - Thank you for helping to improve our Typescript SDK! - - ## The best bug report is a failing test! - - The fastest way to get a bug fixed is to add a failing test and send a pull request. **It's usually easy to do with our bug report test template**. - - 1. Click the "Fork" button - 2. Open our contributions guideline! - 3. Follow the instructions! - - ## I'd rather just report the bug - - That's fine too! Go ahead and fill out this form. - - - type: input - attributes: - label: What version of fuels-ts are you using? - validations: - required: true - - type: textarea - attributes: - label: Steps to Reproduce - description: Steps to reproduce the behavior. - 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: Actual Behavior - description: A concise description of what you're experiencing. - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000000..0086358db1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml deleted file mode 100644 index 2c4dcf18a4..0000000000 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ /dev/null @@ -1,18 +0,0 @@ -name: 🚀 Feature request -description: Suggest an idea for this project. -labels: ["enhancement", "triage"] -body: - - type: textarea - attributes: - label: Motivation - description: Outline the motivation for the proposal. - validations: - required: true - - type: textarea - attributes: - label: Usage example - description: Provide documentation and code examples for how this feature would be used. - - type: textarea - attributes: - label: Possible implementations - description: If possible, describe how this feature could be implemented.