Skip to content

Commit

Permalink
chore: add issue templates (#6097)
Browse files Browse the repository at this point in the history
## Description

Borrowed from the templates in fuelup repo and modified slightly.

When a user opens an issue with either the Bug Report or Enhancement
template, it will have the appropriate label added as well as the
`triage` label.

Closes #2725

## Checklist

- [ ] I have linked to any relevant issues.
- [ ] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [ ] I have added tests that prove my fix is effective or that my
feature works.
- [ ] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [ ] I have requested a review from the relevant team or maintainers.
  • Loading branch information
sdankel authored Jun 8, 2024
1 parent 3f99163 commit 970eb5d
Show file tree
Hide file tree
Showing 4 changed files with 131 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/blank_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
name: Blank Issue
about: Create a blank issue.
---
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug Report
description: Create a report to help us improve.
labels: [bug, triage]
body:
- type: markdown
attributes:
value: >
**Thank you for filing a bug report!**
- type: dropdown
id: component
attributes:
label: Related Component
description: Which component does this relate to?
options:
- compiler
- forc
- forc-deploy
- forc-lsp
- forc-fmt
- another forc plugin
- other
default: 0
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem
description: >
A clear and concise description of what the bug is,
including what currently happens and what you expected to happen.
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps
description: The steps to reproduce the bug.
placeholder: |
1.
2.
3.
validations:
required: true

- type: textarea
id: solutions
attributes:
label: Possible Solution(s)
description: >
Not obligatory, but suggest a fix/reason for the bug,
or ideas how to implement the addition or change.
- type: textarea
id: notes
attributes:
label: Notes

- type: textarea
id: components
attributes:
label: Installed components
description: Output of `fuelup check`, if using `fuelup`. Otherwise, list the relevant component(s) and version(s).
render: console
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Fuel Network & Sway Language Community Support
url: https://forum.fuel.network/
about: Please ask and answer questions here.
- name: Fuel Network Security Bug Bounty
url: https://immunefi.com/boost/fuel-network-attackathon/
about: Please report security vulnerabilities here.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Enhancement Request
description: Suggest an enhancement for this project.
labels: [enhancement, triage]
body:
- type: markdown
attributes:
value: >
**Thank you for filing an enhancement request!**
- type: dropdown
id: component
attributes:
label: Related Component
description: Which component does this relate to?
options:
- compiler
- forc
- forc-deploy
- forc-lsp
- forc-fmt
- another forc plugin
- other
default: 0
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem you are trying to solve
description: >
A clear and concise description of the problem this enhancement request is trying to solve.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Solution you'd like
description: >
A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: notes
attributes:
label: Notes
description: >
Any additional context or information you feel may be relevant to the issue.

0 comments on commit 970eb5d

Please sign in to comment.