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

docs: port issue templates over to YAML #1004

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
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
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-reports.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug Report
description: Report a bug or issue to help us improve.
title: "[Bug]: "
labels: ["bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for helping us improve! Please provide as much detail as possible to ensure we can address the issue effectively.
- type: textarea
id: describe-bug
attributes:
label: Describe the bug
description: |
Provide a clear and concise description of what the bug is.
placeholder: Describe the issue in detail.
validations:
required: true
- type: textarea
id: reproduce-steps
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: |
A clear and concise description of what you expected to happen.
placeholder: Explain the expected outcome.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context or information about the problem here.
placeholder: Include any related logs, error messages, or configurations.
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: |
If applicable, add screenshots to help explain your problem. Provide links or attach images in the comments after submitting the issue.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I checked for duplicate issues.
- label: I checked existing discussions.
- label: This issue is not included in the roadmap.
- label: This issue is present on both stable and development branches.
required: true

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Linutil documentation
url: https://chris-titus-docs.github.io/linutil-docs/
about: check out the docs
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-reqests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Feature Request
description: Suggest a new feature or improvement to help us enhance this project.
title: "[Feature Request]: "
labels: ["enhancement"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a feature or enhancement! Please provide as much detail as possible to help us understand your request. Note that submitting a feature request does not guarantee implementation.
- type: textarea
id: related-problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: |
Provide a clear and concise description of the problem, if applicable.
placeholder: I'm always frustrated when ...
- type: textarea
id: proposed-solution
attributes:
label: Describe the solution you'd like
description: |
Provide a clear and concise description of what you want to happen.
placeholder: Explain your proposed feature or enhancement in detail.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: |
Provide a clear and concise description of any alternative solutions or features you've considered.
placeholder: Explain any other approaches or solutions you've thought about.
- type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.
placeholder: Provide additional information, screenshots, or references to explain your request further.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I checked for duplicate issues.
- label: I checked already existing discussions.
- label: This feature is not included in the roadmap.
required: true
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

Loading