From 34ea178f5bf51c1dbd7295d172c174016c385562 Mon Sep 17 00:00:00 2001 From: Van Pham <64197333+Van-QA@users.noreply.github.com> Date: Thu, 13 Jun 2024 14:46:02 +0700 Subject: [PATCH] chore: Refactor/issue template feature request (#3037) * refactor: add issue template form for bug * refactor: config blank_issues_enabled: false * refactor: config feature request * refactor: config feature request --------- Co-authored-by: Van-QA --- .github/ISSUE_TEMPLATE/bug_report.md | 37 ----------------- .github/ISSUE_TEMPLATE/bug_report.yml | 11 ++--- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/discussion-thread.md | 16 -------- .../ISSUE_TEMPLATE/documentation-request.md | 2 +- .github/ISSUE_TEMPLATE/epic-request.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 17 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 40 +++++++++++++++++++ 8 files changed, 46 insertions(+), 81 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/discussion-thread.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a6fa42e2d..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Bug 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 81700817e..d0662b165 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,14 +4,9 @@ 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: "Is there an existing issue for this?" + label: "Thanks for taking the time to fill out this bug report!" 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" @@ -50,7 +45,7 @@ body: 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" + 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: @@ -63,7 +58,7 @@ body: attributes: label: "Package version" description: "Which version of `Jan` are you using?" - placeholder: "e.g., 0.5.x-xxx nightly or stable" + placeholder: "e.g. 0.5.x-xxx nightly or stable" - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ddb6e57e1..f132b12c5 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,4 +4,4 @@ blank_issues_enabled: false contact_links: - name: "\u2753 Our GitHub Discussions page" url: "https://github.com/orgs/janhq/discussions/categories/q-a" - about: "Please ask and answer questions here!" + about: "Please ask and answer questions here!" \ 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 d15921191..000000000 --- a/.github/ISSUE_TEMPLATE/discussion-thread.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Discussion thread -about: Start an open ended discussion -title: 'Discussion: [TOPIC HERE]' -labels: 'type: discussion' -assignees: '' - ---- - -**Motivation** - -**Discussion** - -**Alternatives** - -**Resources** diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md index 2f2b44f12..6bd343b8e 100644 --- a/.github/ISSUE_TEMPLATE/documentation-request.md +++ b/.github/ISSUE_TEMPLATE/documentation-request.md @@ -1,5 +1,5 @@ --- -name: Documentation request +name: "\U+1F56E Documentation request" about: Documentation requests title: 'docs: TITLE' labels: 'type: documentation' diff --git a/.github/ISSUE_TEMPLATE/epic-request.md b/.github/ISSUE_TEMPLATE/epic-request.md index 51941c412..ef5f63115 100644 --- a/.github/ISSUE_TEMPLATE/epic-request.md +++ b/.github/ISSUE_TEMPLATE/epic-request.md @@ -1,7 +1,7 @@ --- name: Epic request about: Suggest an idea for this project -title: 'epic: [DESCRIPTION]' +title: '\U0001F4A5 epic: [DESCRIPTION]' labels: 'type: epic' assignees: '' 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..748525e03 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: "\U0001F680 Feature Request" +description: "Suggest an idea for this project \U0001F63B!" +title: 'feat: [DESCRIPTION]' +labels: 'type: feature request' +body: + - type: checkboxes + attributes: + label: "Thanks for taking the time to fill out this form!" + 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" + placeholder: | + I'm always frustrated when ... + + - type: textarea + validations: + required: true + attributes: + label: "Describe the solution you'd like" + 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"