Skip to content

Commit

Permalink
chore: refresh issue templates for better clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
thekiba committed Dec 4, 2023
1 parent ffc7bcc commit 8778f6c
Show file tree
Hide file tree
Showing 6 changed files with 141 additions and 60 deletions.
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: "Bug report"
title: "[<SDK or UI or UI-REACT or PROTOCOL>]: <description>"
description: "Please describe the bug in detail. Include the area (SDK, UI, UI-REACT, PROTOCOL) in the title."
labels: ["bug"]
assignees: ["thekiba"]

body:
- type: textarea
attributes:
label: "Describe the bug"
description: |
**Please provide the following details:**
- The specific error or exception encountered.
- Stack trace, if available.
- Steps or code snippet to reproduce the bug.
- Screenshot or video demonstrating the issue, if possible.
validations:
required: true

- type: textarea
attributes:
label: "Expected behavior"
description: "Describe what you expected to happen."
placeholder: "I expected that..."
validations:
required: true

- type: textarea
attributes:
label: "Current behavior"
description: "Describe what is actually happening."
placeholder: "Instead, I observed..."
validations:
required: true

- type: textarea
attributes:
label: "Steps to Reproduce"
description: "Please outline the steps to reproduce the bug."
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true

- type: textarea
attributes:
label: "Environment"
description: |
**Please provide the following environment details:**
- Output of `npm ls @tonconnect/{ui-react,ui,sdk,protocol,isomorphic-fetch,isomorphic-eventsource}`.
- Operating System (e.g., iOS, Android, Windows, MacOS, Linux) and version (e.g., 10.15.7).
- Browser (e.g., Chrome, Safari, Firefox) and version (e.g., 86.0.4240.111).
validations:
required: true

- type: textarea
attributes:
label: "Additional context"
description: "Add any other context or information about the problem here."
placeholder: "Additional details..."
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: "Feature request"
title: "[<SDK or UI or UI-REACT or PROTOCOL>]: <brief description>"
description: "Suggest an idea or improvement for this project"
labels: ["enhancement"]

body:
- type: textarea
attributes:
label: "Is your feature request related to a problem?"
description: "Please provide a clear and concise description of what the problem is."
placeholder: "I'm frustrated when..."
validations:
required: true

- type: textarea
attributes:
label: "Describe the solution you'd like"
description: "What would you like to see happen? Please provide a clear and concise description of your ideal solution."
placeholder: "Ideally, I would like..."

- type: textarea
attributes:
label: "Describe alternatives you've considered"
description: "Have you considered any alternative solutions or features? Please provide a clear and concise description."
placeholder: "An alternative solution might be..."

- type: textarea
attributes:
label: "Additional context"
description: "Add any other context, details, or screenshots about the feature request here."
placeholder: "Additional details..."
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/3-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "Question"
title: "[<SDK or UI or UI-REACT or PROTOCOL>]: <brief description of your question>"
description: "Use this template for asking questions related to the SDK, UI, UI-REACT, or PROTOCOL"
labels: ["question"]
assignees: ["thekiba"]

body:
- type: textarea
attributes:
label: "Your Question"
description: "Please write your question in detail here."
placeholder: "What would you like to know about..."
validations:
required: true

- type: textarea
attributes:
label: "Context"
description: "Provide any additional context or details that might help in understanding your question better."
placeholder: "In my project, I am trying to..."

- type: textarea
attributes:
label: "What have you tried so far?"
description: "Describe any steps you have taken or research you have done in trying to find the answer to your question."
placeholder: "I have already tried..."

- type: textarea
attributes:
label: "Relevant Code or Commands"
description: "If applicable, provide any relevant code snippets or command lines that relate to your question."
placeholder: "Here is a snippet of my code..."

- type: checkboxes
attributes:
label: "Documentation Check"
description: |
Please confirm that you have checked the relevant documentation. It might have the answer you're looking for.
Documentation resources:
- [@tonconnect/ui-react Documentation](https://github.com/ton-connect/sdk/blob/main/packages/ui-react/README.md)
- [@tonconnect/ui Documentation](https://github.com/ton-connect/sdk/tree/main/packages/ui/README.md)
- [@tonconnect/sdk Documentation](https://github.com/ton-connect/sdk/blob/main/packages/sdk/README.md)
- [@tonconnect/protocol Documentation](https://github.com/ton-connect/sdk/blob/main/packages/protocol/README.md)
options:
- label: "Yes, I have checked the documentation."
required: true
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

0 comments on commit 8778f6c

Please sign in to comment.