Merge pull request #3605 from janhq/bugreport

chore: fix issue creation templates
This commit is contained in:
Nicole Zhu 2024-09-09 15:33:57 +08:00 committed by GitHub
commit 6956ed1e1c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 54 additions and 131 deletions

View File

@ -1,37 +0,0 @@
---
name: "🖋️ 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,79 +4,40 @@ 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: "#"
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"
required: false
- type: textarea
validations:
required: true
attributes:
label: "Current behavior"
description: "A clear and concise description of what the bug is"
- type: textarea
validations:
required: true
attributes:
label: "Minimum reproduction step"
description: |
Please list out steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: textarea
validations:
required: true
attributes:
label: "Expected behavior"
description: "A clear and concise description of what you expected to happen"
- type: textarea
validations:
required: true
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
**Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in
- type: markdown
attributes:
value: |
---
- type: input
validations:
required: true
attributes:
label: "Jan version"
description: "**Tip:** The version is located in the lower right conner of the Jan app"
placeholder: "e.g. 0.5.x-xxx nightly or stable"
description: "**Tip:** The version is in the app's bottom right corner"
placeholder: "e.g. 0.5.x-xxx"
- type: checkboxes
- type: textarea
validations:
required: true
attributes:
label: "In which operating systems have you tested?"
options:
- label: macOS
- label: Windows
- label: Linux
label: "Describe the Bug"
description: "A clear & concise description of the bug"
- type: textarea
attributes:
label: "Environment details"
label: "Steps to Reproduce"
description: |
- Operating System: [Specify your OS details: e.g., MacOS Sonoma 14.2.1, Windows 11, Ubuntu 22, etc]
- 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]
Please list out steps to reproduce the issue
placeholder: |
1. Go to '...'
2. Click on '...'
- type: textarea
attributes:
label: "Screenshots / Logs"
description: |
You can find logs in: ~/jan/logs/app.logs
- type: checkboxes
attributes:
label: "What is your OS?"
options:
- label: MacOS
- label: Windows
- label: Linux

View File

@ -2,6 +2,6 @@
blank_issues_enabled: true
contact_links:
- name: "\u2753 Our GitHub Discussions page"
- name: "\1F4AC Jan Discussions"
url: "https://github.com/orgs/janhq/discussions/categories/q-a"
about: "Please ask and answer questions here!"
about: "Get help, discuss features & roadmap, and share your projects"

View File

@ -1,26 +1,14 @@
name: "\U0001F680 Feature Request"
description: "Suggest an idea for this project \U0001F63B!"
title: 'feat: [DESCRIPTION]'
title: 'idea: [DESCRIPTION]'
labels: 'type: feature request'
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this form!"
- type: checkboxes
attributes:
label: "#"
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: "Background"
description: "Briefly describe the context or problem that led to this feature request"
label: "Problem Statement"
description: "Describe the problem you're facing"
placeholder: |
I'm always frustrated when ...
@ -28,15 +16,5 @@ body:
validations:
required: true
attributes:
label: "Feature request"
description: "Clearly describe the feature or improvement you're proposing"
- type: textarea
attributes:
label: "Proposed Implementation"
description: "If you have ideas on how this could be implemented, describe them here"
- type: textarea
attributes:
label: "Additional Notes"
description: "Any other relevant information, considerations, or screenshots"
label: "Feature Idea"
description: "Describe what you want instead. Examples are welcome!"

View File

@ -0,0 +1,21 @@
name: "\U0001F929 Model Request"
description: "Request a new model to be compiled"
title: 'feat: [DESCRIPTION]'
labels: 'type: model request'
body:
- type: markdown
attributes:
value: "**Tip:** Download any HuggingFace model in app ([see guides](https://jan.ai/docs/models/manage-models#add-models)). Use this form for unsupported models only."
- type: textarea
validations:
required: true
attributes:
label: "Model Requests"
description: "If applicable, include the source URL, licenses, and any other relevant information"
- type: checkboxes
attributes:
label: "Which formats?"
options:
- label: GGUF (llama.cpp)
- label: TensorRT (TensorRT-LLM)
- label: ONNX (Onnx Runtime)