From 48b2773c8f0207fcb96af175efc083d4504ffec7 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 13:06:20 +0800 Subject: [PATCH 1/7] chore: fix bug template --- .github/ISSUE_TEMPLATE/bug_report.md | 37 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 91 ++++++++------------------- 2 files changed, 26 insertions(+), 102 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 982e9f412..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -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. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 419643e51..be0f34319 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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] \ No newline at end of file + 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 From 1c9342fc08f8e29b4dc4cdf8288bbdce62c3939d Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 13:30:44 +0800 Subject: [PATCH 2/7] add model request form --- .github/ISSUE_TEMPLATE/feature_request.yml | 32 +++------------------- .github/ISSUE_TEMPLATE/model_request.yml | 21 ++++++++++++++ 2 files changed, 25 insertions(+), 28 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/model_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 0f7f59f6c..8d961147d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -3,24 +3,12 @@ description: "Suggest an idea for this project \U0001F63B!" title: 'feat: [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: "Is your feature request related to a problem? Please describe it" - description: "A clear and concise description of what the problem is" + label: "Problem Statement" + description: "Describe the problem you're facing" placeholder: | I'm always frustrated when ... @@ -28,17 +16,5 @@ body: validations: required: true attributes: - label: "Describe the solution" - 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" + label: "Feature Description" + 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..6b01d01a6 --- /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 and added to the Hub" +title: 'feat: [DESCRIPTION]' +labels: 'type: model request' +body: + - type: markdown + attributes: + value: "**Tip:** you can download any GGUF model from HuggingFace by pasting its ID in the Hub's search bar." + - 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) From e31921ba4dece266c91be1d04ea68d3147f9834a Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 13:34:38 +0800 Subject: [PATCH 3/7] nit --- .github/ISSUE_TEMPLATE/model_request.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/model_request.yml b/.github/ISSUE_TEMPLATE/model_request.yml index 6b01d01a6..b308fe386 100644 --- a/.github/ISSUE_TEMPLATE/model_request.yml +++ b/.github/ISSUE_TEMPLATE/model_request.yml @@ -1,11 +1,11 @@ name: "\U0001F929 Model Request" -description: "Request a new model to be compiled and added to the Hub" +description: "Request a new model to be compiled" title: 'feat: [DESCRIPTION]' labels: 'type: model request' body: - type: markdown attributes: - value: "**Tip:** you can download any GGUF model from HuggingFace by pasting its ID in the Hub's search bar." + value: "**Tip:** Download any model by HuggingFace URL in the app hub's search bar. Use this form for unsupported models only." - type: textarea validations: required: true From 163952b914a4d0991d2a0c45cac80e84d7385b06 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 13:40:33 +0800 Subject: [PATCH 4/7] discussions --- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e0c100daf..a4372656c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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!" \ No newline at end of file + about: "Get help, discuss features & roadmap, and share your projects" \ No newline at end of file From 85d90865ccaeed1e9a3fb5e8348b42b523d4907f Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 14:59:24 +0800 Subject: [PATCH 5/7] add url --- .github/ISSUE_TEMPLATE/model_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/model_request.yml b/.github/ISSUE_TEMPLATE/model_request.yml index b308fe386..7f7c4f63c 100644 --- a/.github/ISSUE_TEMPLATE/model_request.yml +++ b/.github/ISSUE_TEMPLATE/model_request.yml @@ -5,7 +5,7 @@ labels: 'type: model request' body: - type: markdown attributes: - value: "**Tip:** Download any model by HuggingFace URL in the app hub's search bar. Use this form for unsupported models only." + 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 From 71c5c52c5421cbe321619a4355cc67cbeffe5d1f Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 15:32:21 +0800 Subject: [PATCH 6/7] nit --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 8d961147d..1738b2c4c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -16,5 +16,5 @@ body: validations: required: true attributes: - label: "Feature Description" + label: "Feature Idea" description: "Describe what you want instead. Examples are welcome!" \ No newline at end of file From 9eee7dca52cac1713502d530e750bff28a249c05 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 15:33:10 +0800 Subject: [PATCH 7/7] idea --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 1738b2c4c..b1a10e856 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: "\U0001F680 Feature Request" description: "Suggest an idea for this project \U0001F63B!" -title: 'feat: [DESCRIPTION]' +title: 'idea: [DESCRIPTION]' labels: 'type: feature request' body: - type: textarea