Skip to content

Commit

Permalink
Merge pull request #1177 from janhq/issuetemplate
Browse files Browse the repository at this point in the history
chore: standardize issue templates
  • Loading branch information
freelerobot authored Sep 9, 2024
2 parents dd4562c + 38fb1e8 commit e180fc6
Show file tree
Hide file tree
Showing 8 changed files with 100 additions and 75 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: "\U0001F41B Bug Report"
description: "If something isn't working as expected \U0001F914"
labels: [ "type: bug" ]
title: 'bug: [DESCRIPTION]'

body:
- type: input
validations:
required: true
attributes:
label: "Cortex version"
description: "**Tip:** The version is in the app's bottom right corner"

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

- type: textarea
attributes:
label: "Steps to Reproduce"
description: |
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: ~/cortex/logs
- type: checkboxes
attributes:
label: "What is your OS?"
options:
- label: MacOS
- label: Windows
- label: Linux

- type: checkboxes
attributes:
label: "What engine are you running?"
options:
- label: cortex.llamacpp (default)
- label: cortex.tensorrt-llm (Nvidia GPUs)
- label: cortex.onnx (NPUs, DirectML)
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## To encourage contributors to use issue templates, we don't allow blank issues
blank_issues_enabled: true

contact_links:
- name: "\1F4AC Cortex Discussions"
url: "https://github.com/orgs/janhq/discussions/categories/q-a"
about: "Get help, discuss features & roadmap, and share your projects"
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/discussion-thread.md

This file was deleted.

9 changes: 3 additions & 6 deletions .github/ISSUE_TEMPLATE/epic-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ 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.

**Sub Issues**
**Success Criteria**
-

**Additional context**
Add any other context or screenshots about the epic request here.
**Tasklist**
- [ ]
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: "\U0001F680 Feature Request"
description: "Suggest an idea for this project \U0001F63B!"
title: 'idea: [DESCRIPTION]'
body:
- type: textarea
validations:
required: true
attributes:
label: "Problem Statement"
description: "Describe the problem you're facing"
placeholder: |
I'm always frustrated when ...
- type: textarea
validations:
required: true
attributes:
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 model with `cortex pull HUGGINGFACE_MODEL_ID`. 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 e180fc6

Please sign in to comment.