Skip to content

feat: Add Issues template forms #652

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

Merged
merged 1 commit into from
Nov 3, 2022
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
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Bug Report
description: File a bug report.
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: bug-description
attributes:
label: What happened?
description: Please describe the bug.
placeholder: Description of the bug.
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: What are the steps to reproduce?
description: Please describe the steps to reproduce the bug.
placeholder: |
Step 1: ...
Step 2: ...
Step 3: ...
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: What is the expected behavior?
description: Please describe the behavior you expect.
placeholder: I expect that...
validations:
required: true
- type: textarea
id: error-thrown
attributes:
label: What is the error thrown?
description: Please provide the exact error thrown.
placeholder: "Web3Error.invalidData("Exact error message")"
validations:
required: true
- type: textarea
id: source-path
attributes:
label: What's the stack trace said?
description: Please provide the exact source path.
placeholder: "Sources/Core/Transaction/CodableTransaction.swift:129 func recoverPublicKey()"
validations:
required: true
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Documentation Request
description: Suggest documentation you would like added
labels: ['documentation']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this documentation request!
- type: textarea
id: area
attributes:
label: What area of the framework would you like to have improved the documentation for?
description: Please be very specific and link to the relevant page in the documentation if possible.
placeholder: I would like the documentation for...
validations:
required: true
- type: textarea
id: reason
attributes:
label: Why is the current documentation for this area not sufficient?
description: A clear and concise description of why this documentation needs to be improved.
placeholder: The documentation needs to be improved because...
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request
description: Suggest an idea for this project
labels: ['feature']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
placeholder: Yes, the problem is that...
validations:
required: true
- type: textarea
id: solution
attributes:
label: What solution would you like?
description: A clear and concise description of what you want to happen.
placeholder: I would like that...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: What alternatives have you considered?
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: I have considered to...
validations:
required: true
- type: textarea
id: context
attributes:
label: Any additional context?
description: Add any other context or screenshots about the feature request here.