From 378a0e2f4c68373228d7c9a00e7bd2706a1e23fc Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Sun, 24 Dec 2023 12:49:37 +0900 Subject: [PATCH 1/2] docs: update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 116d66543..17dd8f4f8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,34 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve Jan title: 'bug: [DESCRIPTION]' labels: 'type: bug' assignees: '' --- -**Describe the bug** +**Describe the Bug** A clear and concise description of what the bug is. -**To Reproduce** +**Steps to Reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' -4. See error +4. Observe the error -**Expected behavior** +**Expected Behavior** A clear and concise description of what you expected to happen. **Screenshots** -If applicable, add screenshots to help explain your problem. +If applicable, add screenshots to help explain your issue. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**Environment Details** +- Operating System: [Specify your OS. e.g., MacOS Sonoma 14.2.1, Windows 11, Ubuntu 22, etc] +- Jan Version: [e.g., 0.1.3] +- 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] -**Additional context** -Add any other context about the problem here. +**Additional Context** +Add any other context or information that could be helpful in diagnosing the problem. From 0465483a3941e279cdb9a33fec6c3302f5b5107e Mon Sep 17 00:00:00 2001 From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com> Date: Sun, 24 Dec 2023 12:53:38 +0900 Subject: [PATCH 2/2] docs: fix typo --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 17dd8f4f8..0ba8b6669 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,28 +7,28 @@ assignees: '' --- -**Describe the Bug** +**Describe the bug** A clear and concise description of what the bug is. -**Steps to Reproduce** +**Steps to reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' -4. Observe the error +4. See error -**Expected Behavior** +**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** +**Environment details** - Operating System: [Specify your OS. e.g., MacOS Sonoma 14.2.1, Windows 11, Ubuntu 22, etc] - Jan Version: [e.g., 0.1.3] - 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] -**Additional Context** +**Additional context** Add any other context or information that could be helpful in diagnosing the problem.