Skip to content

Commit

Permalink
chore: Refactor/issue template feature request (janhq#3037)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
  • Loading branch information
Van-QA and Van-QA authored Jun 13, 2024
1 parent c7f0eda commit 34ea178
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 81 deletions.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

11 changes: 3 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,9 @@ labels: [ "type: bug" ]
title: 'bug: [DESCRIPTION]'

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
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"
options:
- label: "I have searched the existing issues"
Expand Down Expand Up @@ -50,7 +45,7 @@ body:
attributes:
label: "Screenshots / Logs"
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
- type: markdown
attributes:
Expand All @@ -63,7 +58,7 @@ body:
attributes:
label: "Package version"
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
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ blank_issues_enabled: false
contact_links:
- name: "\u2753 Our GitHub Discussions page"
url: "https://github.com/orgs/janhq/discussions/categories/q-a"
about: "Please ask and answer questions here!"
about: "Please ask and answer questions here!"
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/discussion-thread.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation-request.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Documentation request
name: "\U+1F56E Documentation request"
about: Documentation requests
title: 'docs: TITLE'
labels: 'type: documentation'
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/epic-request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Epic request
about: Suggest an idea for this project
title: 'epic: [DESCRIPTION]'
title: '\U0001F4A5 epic: [DESCRIPTION]'
labels: 'type: epic'
assignees: ''

Expand Down
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit 34ea178

Please sign in to comment.