Skip to content

Commit

Permalink
Merge pull request janhq#3605 from janhq/bugreport
Browse files Browse the repository at this point in the history
chore: fix issue creation templates
  • Loading branch information
freelerobot authored Sep 9, 2024
2 parents ecf83d0 + 9eee7dc commit 6956ed1
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 119 deletions.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

67 changes: 14 additions & 53 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
- type: input
validations:
required: true
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
label: "Jan version"
description: "**Tip:** The version is in the app's bottom right corner"
placeholder: "e.g. 0.5.x-xxx"

- type: textarea
validations:
required: true
attributes:
label: "Current behavior"
description: "A clear and concise description of what the bug is"
label: "Describe the Bug"
description: "A clear & concise description of the bug"

- type: textarea
validations:
required: true
attributes:
label: "Minimum reproduction step"
label: "Steps to Reproduce"
description: |
Please list out steps to reproduce the behavior
Please list out steps to reproduce the issue
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"
2. Click on '...'
- 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"
You can find logs in: ~/jan/logs/app.logs
- type: checkboxes
attributes:
label: "In which operating systems have you tested?"
label: "What is your OS?"
options:
- label: macOS
- label: MacOS
- label: Windows
- label: Linux

- type: textarea
attributes:
label: "Environment details"
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]
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
32 changes: 5 additions & 27 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,42 +1,20 @@
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 ...
- type: textarea
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!"
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/model_request.yml
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 6956ed1

Please sign in to comment.