From 91e7e9454dec3cc079be4dea5549e58b46fecf8c Mon Sep 17 00:00:00 2001 From: Thomas Heyenbrock Date: Fri, 4 Mar 2022 10:22:36 +0100 Subject: [PATCH] minor cleanups --- .github/ISSUE_TEMPLATE/bug_report.yml | 53 ++++++++++----------------- 1 file changed, 19 insertions(+), 34 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9b3824a..8c292d9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -6,14 +6,12 @@ body: value: | Thank you for reporting an issue :pray:. - This issue tracker is for reporting bugs found in `remix-graphql` (https://github.com/thomasheyenbrock/remix-graphql). - If you have a question about how to achieve something and are struggling, please post a question - inside of `remix-graphql` Discussions tab: https://github.com/thomasheyenbrock/remix-graphql/discussions + This issue tracker is for reporting bugs found in `remix-graphql`. If you have a question about how to achieve something and are struggling, please post a question inside of the `remix-graphql` [discussions tab](https://github.com/thomasheyenbrock/remix-graphql/discussions). Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already: - - `remix-graphql` Issues tab: https://github.com/thomasheyenbrock/remix-graphql/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc - - `remix-graphql` closed issues tab: https://github.com/thomasheyenbrock/remix-graphql/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed - - `remix-graphql` Discussions tab: https://github.com/thomasheyenbrock/remix-graphql/discussions + - [open issues](https://github.com/thomasheyenbrock/remix-graphql/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) + - [closed issues](https://github.com/thomasheyenbrock/remix-graphql/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed) + - [discussions](https://github.com/thomasheyenbrock/remix-graphql/discussions) The more information you fill in, the better the community can help you. - type: textarea @@ -28,13 +26,11 @@ body: attributes: label: Your Example Website or App description: | - Which website or app were you using when the bug happened? - Note: + Which website or app were you using when the bug happened? Please note: - Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than this package. - - To create a shareable code example you can use Stackblitz (https://stackblitz.com/). Please no localhost URLs. + - To create a shareable code example you can use [Stackblitz](https://stackblitz.com/). Please no localhost URLs. - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve. - placeholder: | - e.g. https://stackblitz.com/edit/...... OR Github Repo + placeholder: https://stackblitz.com/edit/XYZ or GitHub repository validations: required: true - type: textarea @@ -43,9 +39,9 @@ body: label: Steps to Reproduce the Bug or Issue description: Describe the steps we have to take to reproduce the behavior. placeholder: | - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' + 1. Go to ___ + 2. Click on ___ + 3. Scroll down to ___ 4. See error validations: required: true @@ -63,39 +59,28 @@ body: 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 ↓ + If applicable, add screenshots or a video to help explain your problem. See [here](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files) for more information on the supported file image/file types and the file size limits. + placeholder: You can drag your video or image files inside of this editor ↓ - type: input id: javascript_runtime_version attributes: - label: Javascript Run time version - description: | - The version of node.js, deno, cloudflare etc... you are currently using. + label: Javascript runtime version + description: The version of Node.js, Deno, Cloudflare etc. you are currently using. + placeholder: Node.js vX.Y.Z, ... validations: required: true - type: input id: deploy_target attributes: label: Deploy Target - description: | - Which platform you deploying to? Examples: Vanilla Remix Server, Vercel, CF Worker, Deno, etc.. - validations: - required: true + description: Which platform you deploying to? + placeholder: Remix Server, Vercel, CF Worker, Deno, ... - type: input id: operating_system attributes: label: Operating System - description: | - Which operating are you currently using? - placeholder: | - Example: - - MacOS Sierra, - - Windows 10, - - Linux (Ubuntu, Debian etc) - - ... + description: Which operating are you currently using? + placeholder: MacOS Monterey, Linux (Ubuntu, Debian etc), ... validations: required: true - type: textarea