chore: Refactor/issue template feature request (#3037)

* refactor: add issue template form for bug

* refactor: config blank_issues_enabled: false

* refactor: config feature request

* refactor: config feature request

---------

Co-authored-by: Van-QA <van@jan.ai>
This commit is contained in:
Van Pham 2024-06-13 14:46:02 +07:00 committed by GitHub
parent c7f0edae34
commit 34ea178f5b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 46 additions and 81 deletions

View File

@ -1,37 +0,0 @@
---
name: Bug report
about: Create a report to help us improve Jan
title: 'bug: [DESCRIPTION]'
labels: 'type: bug'
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**Steps to reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your issue.
**Environment details**
- Operating System: [Specify your OS. e.g., MacOS Sonoma 14.2.1, Windows 11, Ubuntu 22, etc]
- Jan Version: [e.g., 0.4.xxx nightly or manual]
- Processor: [e.g., Apple M1, Intel Core i7, AMD Ryzen 5, etc]
- RAM: [e.g., 8GB, 16GB]
- Any additional relevant hardware specifics: [e.g., Graphics card, SSD/HDD]
**Logs**
If the cause of the error is not clear, kindly provide your usage logs: https://jan.ai/docs/troubleshooting#how-to-get-error-logs
**Additional context**
Add any other context or information that could be helpful in diagnosing the problem.

View File

@ -4,14 +4,9 @@ labels: [ "type: bug" ]
title: 'bug: [DESCRIPTION]' title: 'bug: [DESCRIPTION]'
body: body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes - type: checkboxes
attributes: attributes:
label: "Is there an existing issue for this?" label: "Thanks for taking the time to fill out this bug report!"
description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the bug you encountered" description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
options: options:
- label: "I have searched the existing issues" - label: "I have searched the existing issues"
@ -50,7 +45,7 @@ body:
attributes: attributes:
label: "Screenshots / Logs" label: "Screenshots / Logs"
description: | description: |
"Kindly provide your screenshots / [usage logs](https://jan.ai/docs/troubleshooting#how-to-get-error-logs) that could be helpful in diagnosing the problem" Kindly provide your screenshots / [usage logs](https://jan.ai/docs/troubleshooting#how-to-get-error-logs) that could be helpful in diagnosing the problem
**Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in **Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in
- type: markdown - type: markdown
attributes: attributes:
@ -63,7 +58,7 @@ body:
attributes: attributes:
label: "Package version" label: "Package version"
description: "Which version of `Jan` are you using?" description: "Which version of `Jan` are you using?"
placeholder: "e.g., 0.5.x-xxx nightly or stable" placeholder: "e.g. 0.5.x-xxx nightly or stable"
- type: checkboxes - type: checkboxes
attributes: attributes:

View File

@ -1,16 +0,0 @@
---
name: Discussion thread
about: Start an open ended discussion
title: 'Discussion: [TOPIC HERE]'
labels: 'type: discussion'
assignees: ''
---
**Motivation**
**Discussion**
**Alternatives**
**Resources**

View File

@ -1,5 +1,5 @@
--- ---
name: Documentation request name: "\U+1F56E Documentation request"
about: Documentation requests about: Documentation requests
title: 'docs: TITLE' title: 'docs: TITLE'
labels: 'type: documentation' labels: 'type: documentation'

View File

@ -1,7 +1,7 @@
--- ---
name: Epic request name: Epic request
about: Suggest an idea for this project about: Suggest an idea for this project
title: 'epic: [DESCRIPTION]' title: '\U0001F4A5 epic: [DESCRIPTION]'
labels: 'type: epic' labels: 'type: epic'
assignees: '' assignees: ''

View File

@ -1,17 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'feat: [DESCRIPTION]'
labels: 'type: feature request'
assignees: ''
---
**Problem**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Success Criteria**
A clear and concise description of what you want to happen.
**Additional context**
Add any other context or screenshots about the feature request here.

View File

@ -0,0 +1,40 @@
name: "\U0001F680 Feature Request"
description: "Suggest an idea for this project \U0001F63B!"
title: 'feat: [DESCRIPTION]'
labels: 'type: feature request'
body:
- type: checkboxes
attributes:
label: "Thanks for taking the time to fill out this form!"
description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the feature you are requesting"
options:
- label: "I have searched the existing issues"
required: false
- type: textarea
validations:
required: true
attributes:
label: "Is your feature request related to a problem? Please describe it"
description: "A clear and concise description of what the problem is"
placeholder: |
I'm always frustrated when ...
- type: textarea
validations:
required: true
attributes:
label: "Describe the solution you'd like"
description: "Description of what you want to happen. Add any considered drawbacks"
- type: textarea
attributes:
label: "Teachability, documentation, adoption, migration strategy"
description: "Explain how users will be able to use this and possibly write out something for the docs. Maybe a screenshot or design?"
- type: textarea
validations:
required: true
attributes:
label: "What is the motivation / use case for changing the behavior?"
description: "Describe the motivation or the concrete use case"