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

chore(ci): Add issue template #6

Merged
merged 1 commit into from
Nov 26, 2024
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
124 changes: 124 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: Bug report
title: "[Bug][Module Name] Bug title "
description: Create a report to help us improve
labels: [ "bug" ]
body:
- type: markdown
attributes:
value: >
Thank you for taking the time to report a bug. The `[Module Name]` in title see
[here](https://github.com/lyric-project/lyric/labels?q=Module),
if you don't know the module name, you don't have to fill it in.

- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/lyric-project/lyric/issues)
first to see whether the same issue was reported already.
options:
- label: >
I had searched in the [issues](https://github.com/lyric-project/lyric/issues) and found
no similar issues.
required: true

- type: dropdown
id: system-information
attributes:
label: Operating system information
description: Operating system you use
options:
- Linux
- Windows
- MacOS(x86)
- MacOS(M1, M2...)
- Other
validations:
required: true

- type: dropdown
id: python-version
attributes:
label: Python version information
description: Python version you use
options:
- ">=3.13"
- "3.12"
- "3.11"
- "3.10"
- "<3.10"
validations:
required: true

- type: dropdown
id: code-version
attributes:
label: Lyric version
description: >
Which version of Lyric are you running?
options:
- main
- latest release
- v0.1.4
- v0.1.5
- <v0.1.4
validations:
required: true

- type: textarea
attributes:
label: What happened
description: Describe the bug
placeholder: >
A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: What you expected to happen
description: What do you think went wrong?
placeholder: >
Thank you for your feedback! To better understand the issue:

1. Please describe why you believe the behavior is incorrect.

2. Share the relevant log segments or error messages. For UI issues, screenshots are appreciated.

3. For textual data, kindly copy and paste rather than using screenshots to facilitate easier searches in the future.
validations:
required: true

- type: textarea
attributes:
label: How to reproduce
description: >
What should we do to reproduce the problem?
placeholder: >
Steps to reproduce the behavior:
1. Install '...'
2. Run '....'

validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Any other context about the problem here?
placeholder: >
Add any other context about the problem here.

- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
It's completely optional, but if you're interested in contributing, we're here to help!
If you have insights on the solution, that's even better. Lyric thrives on community support,
and we warmly welcome new contributors.
options:
- label: Yes I am willing to submit a PR!

- type: markdown
attributes:
value: "Thanks for completing our form!"
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-related.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Documentation Related
description: Suggest an improvement or report a bug for this project's Documentation
title: "[Doc][Module Name] Documentation bug or improvement"
labels: [ "documentation" ]
body:
- type: markdown
attributes:
value: >
Thank you for taking the time to suggest an improvement or report a bug for this project's documentation.
The `[Module Name]` in title see [here](https://github.com/lyric-project/lyric/labels?q=Module),
if you don't know the module name, you don't have to fill it in.

- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/lyric-project/lyric/issues) first
to see whether the same feature was requested already.
options:
- label: >
I had searched in the [issues](https://github.com/lyric-project/lyric/issues) and found no
similar feature requirement.
required: true

- type: textarea
attributes:
label: Description
description: A short description why your find in our document.

- type: textarea
attributes:
label: Documentation Links
description: Copy and paste one or more links of this documentation issue.

- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
It's completely optional, but if you're interested in contributing, we're here to help!
If you have insights on the solution, that's even better. Lyric thrives on community support,
and we warmly welcome new contributors.
options:
- label: Yes I am willing to submit a PR!

- type: markdown
attributes:
value: "Thanks for completing our form!"
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature][Module Name] Feature title"
labels: [ "enhancement" ]
body:
- type: markdown
attributes:
value: >
Thank you for taking the time to suggest an idea for this project.
The `[Module Name]` in title see [here](https://github.com/lyric-project/lyric/labels?q=Module),
if you don't know the module name, you don't have to fill it in.

- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/lyric-project/lyric/issues) first
to see whether the same feature was requested already.
options:
- label: >
I had searched in the [issues](https://github.com/lyric-project/lyric/issues) and found no
similar feature requirement.
required: true

- type: textarea
attributes:
label: Description
description: A short description of your feature

- type: textarea
attributes:
label: Related issues
description: Is there currently another issue associated with this?

- type: dropdown
id: priority
attributes:
label: Feature Priority
description: How would you rank the importance of this feature?
options:
- High
- Medium
- Low

- type: checkboxes
attributes:
label: Are you willing to submit PR?
description: >
It's completely optional, but if you're interested in contributing, we're here to help!
If you have insights on the solution, that's even better. Lyric thrives on community support,
and we warmly welcome new contributors.
options:
- label: Yes I am willing to submit a PR!

- type: markdown
attributes:
value: "Thanks for completing our form!"
Loading