Skip to content
Open
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
141 changes: 70 additions & 71 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,83 +4,82 @@ title: "[Bug]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report a bug. Please provide as much information as possible.

* type: markdown
attributes:
value: |
Thank you for taking the time to report a bug. Please provide as much information as possible.
- type: textarea
id: description
attributes:
label: Bug Description
description: Provide a clear and concise description of the issue.
placeholder: Describe the bug...
validations:
required: true

* type: textarea
id: description
attributes:
label: Bug Description
description: Provide a clear and concise description of the issue.
placeholder: Describe the bug...
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Help us reproduce the issue.
placeholder: |
1. Go to...
2. Click on...
3. Scroll down to...
4. Observe the issue...
validations:
required: true

* type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Help us reproduce the issue.
placeholder: |
1. Go to...
2. Click on...
3. Scroll down to...
4. Observe the issue...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What should happen instead?
validations:
required: true

* type: textarea
id: expected
attributes:
label: Expected Behavior
description: What should happen instead?
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true

* type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true
- type: dropdown
id: severity
attributes:
label: Severity
description: How serious is this issue?
options:
- Low
- Medium
- High
- Critical
validations:
required: true

* type: dropdown
id: severity
attributes:
label: Severity
description: How serious is this issue?
options:
- Low
- Medium
- High
- Critical
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots / Screen Recording
description: Add screenshots, GIFs, or recordings if applicable.

* type: textarea
id: screenshots
attributes:
label: Screenshots / Screen Recording
description: Add screenshots, GIFs, or recordings if applicable.
- type: input
id: browser
attributes:
label: Browser
placeholder: Chrome, Firefox, Edge, Safari, etc.

* type: input
id: browser
attributes:
label: Browser
placeholder: Chrome, Firefox, Edge, Safari, etc.
- type: input
id: os
attributes:
label: Operating System
placeholder: Windows 11, Ubuntu 24.04, macOS Sequoia, etc.

* type: input
id: os
attributes:
label: Operating System
placeholder: Windows 11, Ubuntu 24.04, macOS Sequoia, etc.

* type: textarea
id: additional
attributes:
label: Additional Context
description: Any extra information that might help us investigate the issue.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any extra information that might help us investigate the issue.
109 changes: 54 additions & 55 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,57 @@ title: "[Docs]: "
labels: ["documentation"]

body:

* type: markdown
attributes:
value: |
Help us improve the project's documentation by providing the details below.

* type: input
id: section
attributes:
label: "Documentation Section"
description: "Which part of the documentation needs improvement?"
placeholder: "README, Installation Guide, API Docs, Contributing Guide, etc."
validations:
required: true

* type: textarea
id: current-issue
attributes:
label: "Current Issue"
description: "Describe what is unclear, incorrect, outdated, or missing."
placeholder: "The installation instructions are missing..."
validations:
required: true

* type: textarea
id: suggested-change
attributes:
label: "Suggested Changes"
description: "Explain the changes you would like to see."
placeholder: "Add a section explaining..."
validations:
required: true

* type: textarea
id: benefits
attributes:
label: "Benefits"
description: "How would this documentation improvement help users or contributors?"
placeholder: "This would make onboarding easier for new contributors..."

* type: textarea
id: references
attributes:
label: "References / Examples"
description: "Provide links, screenshots, or examples from other projects if applicable."

* type: checkboxes
id: checks
attributes:
label: "Checklist"
options:
- label: "I have checked that this documentation issue has not already been reported."
required: true
- label: "I am willing to contribute the documentation update myself."
required: false
- type: markdown
attributes:
value: |
Help us improve the project's documentation by providing the details below.

- type: input
id: section
attributes:
label: "Documentation Section"
description: "Which part of the documentation needs improvement?"
placeholder: "README, Installation Guide, API Docs, Contributing Guide, etc."
validations:
required: true

- type: textarea
id: current-issue
attributes:
label: "Current Issue"
description: "Describe what is unclear, incorrect, outdated, or missing."
placeholder: "The installation instructions are missing..."
validations:
required: true

- type: textarea
id: suggested-change
attributes:
label: "Suggested Changes"
description: "Explain the changes you would like to see."
placeholder: "Add a section explaining..."
validations:
required: true

- type: textarea
id: benefits
attributes:
label: "Benefits"
description: "How would this documentation improvement help users or contributors?"
placeholder: "This would make onboarding easier for new contributors..."

- type: textarea
id: references
attributes:
label: "References / Examples"
description: "Provide links, screenshots, or examples from other projects if applicable."

- type: checkboxes
id: checks
attributes:
label: "Checklist"
options:
- label: "I have checked that this documentation issue has not already been reported."
required: true
- label: "I am willing to contribute the documentation update myself."
required: false
Loading