From 6a6b0e26f5fe11d24803df626d29b47723707a71 Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 7 Aug 2024 18:20:23 -0400 Subject: [PATCH 1/3] feat: add bug report issue and feature request --- .github/ISSUE_TEMPLATE/blank_issue.md | 4 -- .github/ISSUE_TEMPLATE/bug.yml | 65 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 -- .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++ 4 files changed, 85 insertions(+), 9 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/blank_issue.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/blank_issue.md b/.github/ISSUE_TEMPLATE/blank_issue.md deleted file mode 100644 index 3a72c534f..000000000 --- a/.github/ISSUE_TEMPLATE/blank_issue.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -name: 📝 Create an Issue -about: Create a blank issue. ---- \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..175ed7108 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,65 @@ +name: Bug Report +description: File a bug report to help us improve +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: dropdown + id: software + attributes: + label: Software + description: What software are you referring to? + multiple: true + options: + - Desktop Application + - Pieces OS + - Web Extension + - VS Code + - JetBrains + - Obsidian + - Visual Studio + - JupyterLab + - Microsoft Teams + - Sharing Web App + - Marketing Site (pieces.app) + - Blog (code.pieces.app/blog) + - Release Notes (code.pieces.app/updates) + default: 0 + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating System / Platform + description: What operating system / platform are you using? + options: + - macOS + - Windows + - Linux + - Web + default: 0 + validations: + required: true + - type: input + id: pieces-os-version + attributes: + label: Your Pieces OS Version + description: Add the version of Pieces OS installed in your system + validations: + required: true + - type: checkboxes + id: early_access_program + attributes: + label: Early Access Program + description: Is this issue related to a feature in our Early Access Program? + options: + - label: Yes, this is related to an Early Access Program feature. + - type: textarea + id: description + attributes: + label: Kindly describe the bug and include as much detail as possible on what you were doing so we can reproduce the bug. + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 89a46f571..000000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,5 +0,0 @@ -blank_issues_enabled: true -contact_links: - - name: Feature or Enhancement Request - url: https://github.com/pieces-app/support/discussions - about: Post your idea in discussions for the Pieces team and community to discuss! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..6532412f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file From 6ce46dd0a158076f6f60a908281d4e970e99e221 Mon Sep 17 00:00:00 2001 From: choir27 Date: Wed, 7 Aug 2024 19:46:46 -0400 Subject: [PATCH 2/3] docs: add sublime, raycast, and other extensions --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 175ed7108..3fa43d3b6 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -19,9 +19,13 @@ body: - JetBrains - Obsidian - Visual Studio + - Raycast - JupyterLab + - Pieces CLI - Microsoft Teams - Sharing Web App + - Sublime Text + - Azure Data Studio - Marketing Site (pieces.app) - Blog (code.pieces.app/blog) - Release Notes (code.pieces.app/updates) From f72eadc1a06edea9d58ad31677e89cd79b552d9f Mon Sep 17 00:00:00 2001 From: choir27 Date: Tue, 27 Aug 2024 18:42:58 -0400 Subject: [PATCH 3/3] undo deletion of blank_issue and config files, update config.yml values, replace feature request for enhancement and update content accordingly --- .github/ISSUE_TEMPLATE/blank_issue.md | 4 ++ .github/ISSUE_TEMPLATE/bug.yml | 69 ------------------- .github/ISSUE_TEMPLATE/config.yml | 5 ++ .../{feature_request.md => enhancement.md} | 4 +- 4 files changed, 11 insertions(+), 71 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/blank_issue.md delete mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml rename .github/ISSUE_TEMPLATE/{feature_request.md => enhancement.md} (77%) diff --git a/.github/ISSUE_TEMPLATE/blank_issue.md b/.github/ISSUE_TEMPLATE/blank_issue.md new file mode 100644 index 000000000..3a72c534f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank_issue.md @@ -0,0 +1,4 @@ +--- +name: 📝 Create an Issue +about: Create a blank issue. +--- \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml deleted file mode 100644 index 3fa43d3b6..000000000 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ /dev/null @@ -1,69 +0,0 @@ -name: Bug Report -description: File a bug report to help us improve -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: dropdown - id: software - attributes: - label: Software - description: What software are you referring to? - multiple: true - options: - - Desktop Application - - Pieces OS - - Web Extension - - VS Code - - JetBrains - - Obsidian - - Visual Studio - - Raycast - - JupyterLab - - Pieces CLI - - Microsoft Teams - - Sharing Web App - - Sublime Text - - Azure Data Studio - - Marketing Site (pieces.app) - - Blog (code.pieces.app/blog) - - Release Notes (code.pieces.app/updates) - default: 0 - validations: - required: true - - type: dropdown - id: os - attributes: - label: Operating System / Platform - description: What operating system / platform are you using? - options: - - macOS - - Windows - - Linux - - Web - default: 0 - validations: - required: true - - type: input - id: pieces-os-version - attributes: - label: Your Pieces OS Version - description: Add the version of Pieces OS installed in your system - validations: - required: true - - type: checkboxes - id: early_access_program - attributes: - label: Early Access Program - description: Is this issue related to a feature in our Early Access Program? - options: - - label: Yes, this is related to an Early Access Program feature. - - type: textarea - id: description - attributes: - label: Kindly describe the bug and include as much detail as possible on what you were doing so we can reproduce the bug. - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! - validations: - required: true \ 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..5ad373a87 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Feature, Bug Report, or Enhancement + url: https://github.com/pieces-app/support/discussions + about: Post your idea in discussions for the Pieces team and community to discuss! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/enhancement.md similarity index 77% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/enhancement.md index 6532412f5..148b668b9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -7,7 +7,7 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** +**Is your enhancement related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] **Describe the solution you'd like** @@ -17,4 +17,4 @@ A clear and concise description of what you want to happen. A clear and concise description of any alternative solutions or features you've considered. **Additional context** -Add any other context or screenshots about the feature request here. \ No newline at end of file +Add any other context or screenshots about the enhancement here. \ No newline at end of file