From 31e3bd69f26166022978e19d7413d9fec0e8f42e Mon Sep 17 00:00:00 2001 From: clifford Date: Mon, 17 Jan 2022 15:19:40 -0800 Subject: [PATCH 1/7] add github issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 99 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature-request.yml | 43 ++++++++++ 3 files changed, 147 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..cc99fee59e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,99 @@ +name: '🐛 Bug report' +description: Report a reproducible bug or regression +body: + - type: markdown + attributes: + value: | + Thank you for reporting an issue :pray: + + This issue tracker is for reporting reproducible bugs or regression's found in [excalidraw](https://github.com/excalidraw/excalidraw) + If you have a question about how to achieve something and are struggling, please post a question + inside of excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions) + + Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already: + - excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions) + - excalidraw's [Open Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) + - excalidraw's [Closed Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed) + + The more information you fill in, the better the community can help you. + - type: textarea + id: description + attributes: + label: Describe the bug + description: Provide a clear and concise description of the challenge you are running into. + validations: + required: true + - type: input + id: excalidraw-link + attributes: + label: Your minimal, reproducible example + description: | + Please share a link to your excalidraw file. + 1. Export your excalidraw file to your computer + 2. Copy the content of the `.excalidraw` file (FYI: this is actually JSON content) + 3. Open the following page to share your copied code & call the filename `my-excalidraw.json`: https://gist.github.com/ + Note: + - Your bug may get fixed much faster if we can run your code + - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve. + placeholder: | + A link to your excalidraw file: https://gist.github.com/.... + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Describe the steps we have to take to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: Provide a clear and concise description of what you expected to happen. + placeholder: | + As a user, I expected ___ behavior but i am seeing ___ + validations: + required: true + - type: dropdown + attributes: + label: How often does this bug happen? + description: | + Following the repro steps above, how easily are you able to reproduce this bug? + options: + - Every time + - Often + - Sometimes + - Only once + - type: textarea + id: screenshots_or_videos + attributes: + label: Screenshots or Videos + description: | + If applicable, add screenshots or a video to help explain your problem. + For more information on the supported file image/file types and the file size limits, please refer + to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files + placeholder: | + You can drag your video or image files inside of this editor ↓ + - type: textarea + id: platform + attributes: + label: Platform + description: | + Please let us know which Operting System, Browser and Browser version you were using when the issue occurred. + placeholder: | + - OS: [e.g. macOS, Windows, Linux, iOS, Android] + - Browser: [e.g. Chrome, Safari, Firefox, React Native] + - Version: [e.g. 91.1] + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..ade3c55df0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Feature Requests & Questions + url: https://github.com/excalidraw/excalidraw/discussions + about: Please ask and answer questions here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..4d4cec2fa5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,43 @@ +name: 'Feature Request' +description: Suggest a new feature +body: + - type: markdown + attributes: + value: | + Thank you for tacking the time to request a new feature :pray: + + This form for suggesting new feature's or enhancements for [excalidraw](https://github.com/excalidraw/excalidraw) + If you have a question about how to achieve something and are struggling, please post a question + inside of excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions) + + Before submitting a feature request, please check the links below to see if there is a solution, feature request or question posted there already: + - excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions) + - excalidraw's [Open Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) + - excalidraw's [Closed Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed) + + The more information you fill in, the better the community can help you. + - type: textarea + id: steps + attributes: + label: Describe the feature you would like see in Excalidraw + description: Provide a clear and concise description. + placeholder: | + Ex. I'm always frustrated when [...] + Ex. I wish there was a way to do [...] + validations: + required: true + - type: textarea + id: screenshots_or_videos + attributes: + label: Screenshots or Videos + description: | + If applicable, add screenshots or a video to help explain your problem. + For more information on the supported file image/file types and the file size limits, please refer + to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files + placeholder: | + You can drag your video or image files inside of this editor ↓ + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. From 64c540dcebe6357c821da6a7be89b751a312a96b Mon Sep 17 00:00:00 2001 From: Clifford Fajardo Date: Tue, 18 Jan 2022 10:17:10 -0800 Subject: [PATCH 2/7] Update .github/ISSUE_TEMPLATE/feature-request.yml Co-authored-by: Aakansha Doshi --- .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 4d4cec2fa5..eb3680283f 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -4,7 +4,7 @@ body: - type: markdown attributes: value: | - Thank you for tacking the time to request a new feature :pray: + Thank you for taking the time to request a new feature :pray: This form for suggesting new feature's or enhancements for [excalidraw](https://github.com/excalidraw/excalidraw) If you have a question about how to achieve something and are struggling, please post a question From bfa2dd466348c2747df13ad35583dda73d3c18d8 Mon Sep 17 00:00:00 2001 From: Clifford Fajardo Date: Tue, 18 Jan 2022 10:17:34 -0800 Subject: [PATCH 3/7] Update .github/ISSUE_TEMPLATE/feature-request.yml Co-authored-by: Aakansha Doshi --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index cc99fee59e..2de65e4270 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -38,7 +38,7 @@ body: placeholder: | A link to your excalidraw file: https://gist.github.com/.... validations: - required: true + required: false - type: textarea id: steps attributes: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index eb3680283f..10f1558337 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -22,8 +22,8 @@ body: label: Describe the feature you would like see in Excalidraw description: Provide a clear and concise description. placeholder: | - Ex. I'm always frustrated when [...] - Ex. I wish there was a way to do [...] + eg. It would be great if [...] + eg. I wish there was a way to do [...] validations: required: true - type: textarea From 0f9c130ea8604e5f3de573305259d675359acdb0 Mon Sep 17 00:00:00 2001 From: Aakansha Doshi Date: Fri, 22 Jul 2022 19:26:06 +0530 Subject: [PATCH 4/7] update issue template and remove feature template --- .github/ISSUE_TEMPLATE/bug_report.yml | 64 +--------------------- .github/ISSUE_TEMPLATE/feature-request.yml | 43 --------------- 2 files changed, 1 insertion(+), 106 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2de65e4270..bbf7064d29 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: '🐛 Bug report' +name: "🐛 Bug report" description: Report a reproducible bug or regression body: - type: markdown @@ -23,63 +23,6 @@ body: description: Provide a clear and concise description of the challenge you are running into. validations: required: true - - type: input - id: excalidraw-link - attributes: - label: Your minimal, reproducible example - description: | - Please share a link to your excalidraw file. - 1. Export your excalidraw file to your computer - 2. Copy the content of the `.excalidraw` file (FYI: this is actually JSON content) - 3. Open the following page to share your copied code & call the filename `my-excalidraw.json`: https://gist.github.com/ - Note: - - Your bug may get fixed much faster if we can run your code - - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve. - placeholder: | - A link to your excalidraw file: https://gist.github.com/.... - validations: - required: false - - type: textarea - id: steps - attributes: - label: Steps to reproduce - description: Describe the steps we have to take to reproduce the behavior. - placeholder: | - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - validations: - required: true - - type: textarea - id: expected - attributes: - label: Expected behavior - description: Provide a clear and concise description of what you expected to happen. - placeholder: | - As a user, I expected ___ behavior but i am seeing ___ - validations: - required: true - - type: dropdown - attributes: - label: How often does this bug happen? - description: | - Following the repro steps above, how easily are you able to reproduce this bug? - options: - - Every time - - Often - - Sometimes - - Only once - - type: textarea - id: screenshots_or_videos - attributes: - label: Screenshots or Videos - description: | - If applicable, add screenshots or a video to help explain your problem. - For more information on the supported file image/file types and the file size limits, please refer - to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files - placeholder: | - You can drag your video or image files inside of this editor ↓ - type: textarea id: platform attributes: @@ -92,8 +35,3 @@ body: - Version: [e.g. 91.1] validations: required: true - - type: textarea - id: additional - attributes: - label: Additional context - description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml deleted file mode 100644 index 10f1558337..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ /dev/null @@ -1,43 +0,0 @@ -name: 'Feature Request' -description: Suggest a new feature -body: - - type: markdown - attributes: - value: | - Thank you for taking the time to request a new feature :pray: - - This form for suggesting new feature's or enhancements for [excalidraw](https://github.com/excalidraw/excalidraw) - If you have a question about how to achieve something and are struggling, please post a question - inside of excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions) - - Before submitting a feature request, please check the links below to see if there is a solution, feature request or question posted there already: - - excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions) - - excalidraw's [Open Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) - - excalidraw's [Closed Issues](https://github.com/excalidraw/excalidraw/discussions/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed) - - The more information you fill in, the better the community can help you. - - type: textarea - id: steps - attributes: - label: Describe the feature you would like see in Excalidraw - description: Provide a clear and concise description. - placeholder: | - eg. It would be great if [...] - eg. I wish there was a way to do [...] - validations: - required: true - - type: textarea - id: screenshots_or_videos - attributes: - label: Screenshots or Videos - description: | - If applicable, add screenshots or a video to help explain your problem. - For more information on the supported file image/file types and the file size limits, please refer - to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files - placeholder: | - You can drag your video or image files inside of this editor ↓ - - type: textarea - id: additional - attributes: - label: Additional context - description: Add any other context about the problem here. From b6bca2166209557a3db8bc1036dabdfb8430c324 Mon Sep 17 00:00:00 2001 From: Aakansha Doshi Date: Fri, 22 Jul 2022 20:01:49 +0530 Subject: [PATCH 5/7] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: David Luzar --- .github/ISSUE_TEMPLATE/bug_report.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index bbf7064d29..85a77dfe1e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -30,8 +30,7 @@ body: description: | Please let us know which Operting System, Browser and Browser version you were using when the issue occurred. placeholder: | - - OS: [e.g. macOS, Windows, Linux, iOS, Android] - - Browser: [e.g. Chrome, Safari, Firefox, React Native] - - Version: [e.g. 91.1] + - OS + version: e.g. MacOS Big Sur, Windows 11, Linux, iOS 14, Android + - Browser + version: e.g. Chrome 104, Safari 15, Firefox 102 validations: required: true From b854f659fe6a76d6c8c7e4f5a024d8ec93552a25 Mon Sep 17 00:00:00 2001 From: Aakansha Doshi Date: Fri, 22 Jul 2022 23:14:04 +0530 Subject: [PATCH 6/7] Update .github/ISSUE_TEMPLATE/config.yml --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ade3c55df0..de71ddc316 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: false +blank_issues_enabled: true contact_links: - name: Feature Requests & Questions url: https://github.com/excalidraw/excalidraw/discussions From 0337942c0b0b45c524747a533f243644a423a515 Mon Sep 17 00:00:00 2001 From: Clifford Fajardo Date: Fri, 22 Jul 2022 19:27:32 -0700 Subject: [PATCH 7/7] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: David Luzar --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 85a77dfe1e..4aa0bbd501 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -6,7 +6,7 @@ body: value: | Thank you for reporting an issue :pray: - This issue tracker is for reporting reproducible bugs or regression's found in [excalidraw](https://github.com/excalidraw/excalidraw) + This issue tracker is for reporting reproducible bugs or regression's found in Excalidraw or Excalidraw+ If you have a question about how to achieve something and are struggling, please post a question inside of excalidraw's [Discussions tab](https://github.com/excalidraw/excalidraw/discussions)