diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 837bdb720..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: 'bug: [DESCRIPTION]' -labels: 'type: bug' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**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 problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..d0182a83a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..56e11b10a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/discussion-thread.md b/.github/ISSUE_TEMPLATE/discussion-thread.md deleted file mode 100644 index 09e52ae68..000000000 --- a/.github/ISSUE_TEMPLATE/discussion-thread.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Discussion thread -about: Start an open ended discussion -title: 'Discussion: [TOPIC HERE]' -labels: '' -assignees: '' - ---- - -**Motivation** - -**Discussion** - -**Resources** diff --git a/.github/ISSUE_TEMPLATE/epic-request.md b/.github/ISSUE_TEMPLATE/epic-request.md index bfad8e5f8..486ae90b6 100644 --- a/.github/ISSUE_TEMPLATE/epic-request.md +++ b/.github/ISSUE_TEMPLATE/epic-request.md @@ -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** +- [ ] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 26f586bd0..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..1d267e500 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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!" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/model_request.yml b/.github/ISSUE_TEMPLATE/model_request.yml new file mode 100644 index 000000000..c424de8fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/model_request.yml @@ -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)