From 62bf6d4cc9c069927a21cedf8883682a1e29cefe Mon Sep 17 00:00:00 2001 From: Nicola Molinari Date: Wed, 18 Sep 2024 14:30:38 +0200 Subject: [PATCH] chore: guide issue request through support --- .github/ISSUE_TEMPLATE/bug_report.md | 42 ------------------- .github/ISSUE_TEMPLATE/config.yml | 6 +++ .github/ISSUE_TEMPLATE/feature_request.md | 31 -------------- .../ISSUE_TEMPLATE/improve_documentation.md | 13 ------ README.md | 4 ++ 5 files changed, 10 insertions(+), 86 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/improve_documentation.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8a39884193..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve ---- - - - -**Describe the bug** -A clear and concise description of what the bug is. - -**UI Kit Version Number** -Please provide the version number you are using. - -**Browser + OS** -Please provide the operating system (e.g., Windows 10, macOS Ventura, Ubuntu 22.04) and browser version (e.g., Chrome 116.0, Firefox 117.0) where the issue can be reproduced. - -**Priority** -How important is this to you? Required. - -**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 problem. - -**Additional context** -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..770cbdbd69 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +# https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: true +contact_links: + - name: commercetools Support + url: https://support.commercetools.com + about: Have an issue or question? Ask our support team! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 7073fa124e..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - -**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. - -**For internal requests:** -Please provide us with the following information. - -- **Champion:** - Who will be the primary contact for this request? - -- **Stakeholders:** - List individuals or teams who will be impacted or should be involved in the contribution process. - -- **Required components:** - Describe any dependencies this component or change has on other UI-Kit components. Include a description of how these components interact with one another (in code and/or design). - -- **Best practices:** - Provide a description of what best practices for this component or change would look like, in terms of UX guidelines and design. diff --git a/.github/ISSUE_TEMPLATE/improve_documentation.md b/.github/ISSUE_TEMPLATE/improve_documentation.md deleted file mode 100644 index 24ee7ca964..0000000000 --- a/.github/ISSUE_TEMPLATE/improve_documentation.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Improve documentation -about: Suggest an update to the project’s documentation ---- - -- **Summary** - What should be changed? - -- **Rationale** - Please explain the benefit of this change. - -- **Champion** - If an internal request, who will be the primary contact for this change? diff --git a/README.md b/README.md index 084330e031..1ea19e7e37 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ The UI Kit is a set of React components that follows commercetools [Design System](#design-system). +# Need Help? + +In case you have any questions about or issues with the tools and components provided in this repository, please reach out to our [Support team](https://support.commercetools.com). + # Using individual packages Each UI Kit component is published as a single NPM package under the scope `@commercetools-uikit`. This is useful if you only need a bunch of React components and do not want to have bigger bundle.