From 48b2773c8f0207fcb96af175efc083d4504ffec7 Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 9 Sep 2024 13:06:20 +0800 Subject: [PATCH] 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