From d94702854046e1530a9da4fa5cf649bf03463700 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Wed, 27 Dec 2023 14:25:48 -0600 Subject: [PATCH 1/2] add some templates --- .github/ISSUE_TEMPLATES/bug-report.yml | 29 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATES/config.yml | 13 ++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 .github/ISSUE_TEMPLATES/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATES/config.yml diff --git a/.github/ISSUE_TEMPLATES/bug-report.yml b/.github/ISSUE_TEMPLATES/bug-report.yml new file mode 100644 index 000000000..e0a6dfbad --- /dev/null +++ b/.github/ISSUE_TEMPLATES/bug-report.yml @@ -0,0 +1,29 @@ +name: 🖍️ Incorrect Documentation Report +description: Something is wrong or missing within the Docs. +labels: + - 'bug:unverified' +body: + - type: markdown + attributes: + value: | + Thank you for helping to improve the Developer Documentation! + + ## Tell us what's missing! + + - type: input + attributes: + label: What is the link to the documentation needing updated? + validations: + required: true + - type: textarea + attributes: + label: What needs to be documented? + description: A concise description of what you expected to see here. + validations: + required: true + - type: textarea + attributes: + label: What is currently documented? + description: A concise description of what you're actually seeing. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATES/config.yml b/.github/ISSUE_TEMPLATES/config.yml new file mode 100644 index 000000000..ab36960ab --- /dev/null +++ b/.github/ISSUE_TEMPLATES/config.yml @@ -0,0 +1,13 @@ +blank_issues_enabled: false +contact_links: + - name: Get BigCommerce help + url: https://support.bigcommerce.com/s/contact + about: + If you need to file a BigCommerce bug report our platform outage, utilize our traditional Support Team. Partners, please use your Partner Portal to open a case. + - name: Documentation + DevCenter Feature Request + url: https://github.com/BigCommerce/Docs/discussions/new?category=ideas-feature-requests + about: + We appreciate you taking the time to improve our Documentation with your ideas! Meet us in Discussions to talk further about your feature request. + - name: 💬 BigCommerce Community + url: https://developer.bigcommerce.com/community + about: Meet and chat with other people building on BigCommerce. From 8aa351de81e862113002a5777a34688d02883d07 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Fri, 14 Jun 2024 15:46:43 -0500 Subject: [PATCH 2/2] Apply suggestions from code review --- .github/ISSUE_TEMPLATES/bug-report.yml | 10 +++++----- .github/ISSUE_TEMPLATES/config.yml | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATES/bug-report.yml b/.github/ISSUE_TEMPLATES/bug-report.yml index e0a6dfbad..0dc766b4e 100644 --- a/.github/ISSUE_TEMPLATES/bug-report.yml +++ b/.github/ISSUE_TEMPLATES/bug-report.yml @@ -1,24 +1,24 @@ -name: 🖍️ Incorrect Documentation Report -description: Something is wrong or missing within the Docs. +name: 🖍️ Incorrect documentation report +description: Something is wrong or missing from the docs. labels: - 'bug:unverified' body: - type: markdown attributes: value: | - Thank you for helping to improve the Developer Documentation! + Thank you for helping improve the BigCommerce DevDocs! ## Tell us what's missing! - type: input attributes: - label: What is the link to the documentation needing updated? + label: What is the link to the page that needs updating? Provide multiple links if needed. validations: required: true - type: textarea attributes: label: What needs to be documented? - description: A concise description of what you expected to see here. + description: A concise description of what you expect to see here. validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATES/config.yml b/.github/ISSUE_TEMPLATES/config.yml index ab36960ab..21c4f53a0 100644 --- a/.github/ISSUE_TEMPLATES/config.yml +++ b/.github/ISSUE_TEMPLATES/config.yml @@ -3,11 +3,11 @@ contact_links: - name: Get BigCommerce help url: https://support.bigcommerce.com/s/contact about: - If you need to file a BigCommerce bug report our platform outage, utilize our traditional Support Team. Partners, please use your Partner Portal to open a case. - - name: Documentation + DevCenter Feature Request - url: https://github.com/BigCommerce/Docs/discussions/new?category=ideas-feature-requests + If you need to file a BigCommerce bug report or platform outage, contact our Support team. Contact information is in the store control panel. Partners, please use your Partner Portal to open a case. + - name: Docs + DevCenter feature request + url: https://github.com/bigcommerce/docs/discussions/new?category=ideas-feature-requests about: - We appreciate you taking the time to improve our Documentation with your ideas! Meet us in Discussions to talk further about your feature request. - - name: 💬 BigCommerce Community + We appreciate you taking the time to improve our docs! Meet us in Discussions to talk further about your feature request. + - name: 💬 BigCommerce community url: https://developer.bigcommerce.com/community - about: Meet and chat with other people building on BigCommerce. + about: Meet and chat with other people building with BigCommerce.