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

Added a ISSUE template #787

Merged
merged 9 commits into from
Oct 16, 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
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: "🐛 Bug Report"
description: Create a bug report to help us improve.
title: "🐛 [BUG] - <title>"
labels: [
"bug"
]
body:
- type: textarea
id: expected-behaviour
attributes:
label: "Expected Behaviour"
description: Please describe the behavior you are expecting
placeholder: Short and explicit description of your desired behaviour...
validations:
required: true
- type: textarea
id: current-behaviour
attributes:
label: "Current Behaviour"
description: Please describe the current behavior
placeholder: What is the current behavior?...
validations:
required: true
- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Invoke function '...'
3. See error
render: bash
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Relevant Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
- type: dropdown
id: dapp-env
attributes:
label: "Dapp Env"
description: What is the impacted DApp environment ?
multiple: true
options:
- Prod (app.push.org)
- Staging (staging.push.org)
- Dev (dev.push.org)
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: "Browsers"
description: What browsers are you seeing the problem on ?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Opera
validations:
required: false
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION_README_ISSUE.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: "✏️ Documentation/Readme Enhancement"
description: Suggest an enhancement in documentation/readme.
title: "✏️ [Documentation/Readme Enhancement] - <title>"
labels: [
"documentation"
]
body:
- type: textarea
id: expected-behaviour
attributes:
label: "Expected Behaviour"
description: Please describe the behavior you are expecting
placeholder: Short and explicit description of your desired behaviour...
validations:
required: false
- type: textarea
id: current-behaviour
attributes:
label: "Current Behaviour"
description: Please describe the current behavior
placeholder: What is the current behavior?...
validations:
required: false
- type: textarea
id: reprod
attributes:
label: "Steps to Reproduce"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Invoke function '...'
3. See error
render: bash
validations:
required: false
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/IMPROVEMENT_PROPOSAL.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: "😈 Improvement Proposal"
description: Suggest improvement,whether new or built upon existing features.
title: "😈 [Improvement Proposal] - <title>"
labels: [
"Improvement proposal"
]
body:
- type: input
id: proposal-name
attributes:
label: "Proposal name"
description: Brief title or summary of the proposed improvement.
placeholder: Summary of the proposal improvement.
validations:
required: true
- type: textarea
id: description
attributes:
label: "Describe the Proposal"
description: Please describe detailed description of the improvement, including the problem it solves and the benefits it brings.
placeholder: Detailed description of your desired proposal...
validations:
required: true
- type: textarea
id: usecase
attributes:
label: "Use Case"
description: Please explain the specific use cases or scenarios where this improvement would be valuable..
placeholder: List down the use case.
validations:
required: true
- type: textarea
id: current-limitations
attributes:
label: "Current Limitations"
description: Any existing limitations, issues, or challenges with the SDK that the proposed improvement aims to address.
placeholder: Overview for the current problem/limitations.
validations:
required: true

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/OTHER.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: "👾 Other"
description: Something that doesn't belong elsewhere.
title: "👾 [Other] - <title>"
labels: [
"Other"
]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please describe something
placeholder: Detailed description of what you wanna share...
validations:
required: true
- type: dropdown
id: dapp-env
attributes:
label: "Dapp Env"
description: What is the impacted DApp environment ?
multiple: true
options:
- Prod (app.push.org)
- Staging (staging.push.org)
- Dev (dev.push.org)
validations:
required: false
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION_SUPPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: "❓ Question or Support Request"
description: Questions and requests for support.
title: "❓ [Question/Support] - <title>"
labels: [
"support"
]
body:
- type: textarea
id: support-request
attributes:
label: "Question or Support Request"
description: Describe your question or ask for support.
placeholder: Detailed description of your question/support request...
validations:
required: true
Loading