chore: add github issue template

This commit is contained in:
kangfenmao 2024-12-03 16:06:17 +08:00
parent 115f111071
commit 3b569131a5
3 changed files with 154 additions and 0 deletions

73
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,73 @@
name: 🐛 Bug Report
description: Create a report to help us improve
title: '[Bug]: '
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
id: platform
attributes:
label: Platform
description: What platform are you using?
options:
- Windows
- macOS
- Linux
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of Cherry Studio are you running?
placeholder: e.g. v1.0.0
validations:
required: true
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is
placeholder: Tell us what happened...
validations:
required: true
- type: textarea
id: reproduction
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
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Log Output
description: Please copy and paste any relevant log output
render: shell
- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here

View File

@ -0,0 +1,43 @@
name: 📝 Documentation Issue
description: Report issues with documentation
title: '[Docs]: '
labels: ['documentation']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to improve our documentation!
- type: dropdown
id: type
attributes:
label: Type of documentation issue
options:
- Missing documentation
- Unclear documentation
- Incorrect documentation
- Translation needed
- Other
validations:
required: true
- type: input
id: location
attributes:
label: Documentation Location
description: Where is the documentation you're referring to?
placeholder: e.g. README.md, Contributing Guide, etc.
- type: textarea
id: description
attributes:
label: Description
description: Please describe the issue with the documentation
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested Changes
description: If you have specific suggestions for how to improve the documentation, please provide them here

View File

@ -0,0 +1,38 @@
name: 💡 Feature Request
description: Suggest an idea for this project
title: '[Feature]: '
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature!
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is
placeholder: I'm always frustrated when...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered
- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here