From c788eb4e8b5948eb72c7bebb759da2e32f6da50f Mon Sep 17 00:00:00 2001 From: Gavyn McKenzie <gavyn@etch.co> Date: Fri, 27 Sep 2024 12:01:12 +0100 Subject: [PATCH] docs: support page and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 +++++++++ docs/Support.mdx | 32 +++++++++++++++++++++ 3 files changed, 81 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 docs/Support.mdx diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..b735373 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**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. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..68653fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest a feature to add + +--- + +**Describe the problem to be solved** +A clear and concise description of the problem that will be solved by this feature. + +**(Optional) Suggest a solution** +A concise description of the preferred solution. + +**Additional context** +Add any other context about the problem here. diff --git a/docs/Support.mdx b/docs/Support.mdx new file mode 100644 index 0000000..7d8c1c5 --- /dev/null +++ b/docs/Support.mdx @@ -0,0 +1,32 @@ +import { Meta } from '@storybook/blocks'; + +<Meta title="Docs/Support" /> + +# Support + +> Report a problem which relates to this project, and a member of the Etch team will respond as quickly as possible. + +### Support Hours + +Support is available inside our standard working hours of 10:00 to 18:00 Monday to Friday UK time. + +### Requesting support + +You can email [support@etch.co](mailto:support@etch.co) and provide as much information about the issue, to ensure we can meet the response times below. + +Alternatively, if you have a code-specific question or problem you can [raise an issue on GitHub](https://github.com/etchteam/diamond-ui/issues/new). + +### Response times + +We classify each request as either “Critical” or “Normal” and respond to each type appropriately: + +1. **Critical** – an issue that prevents normal use of a web application. We aim to respond within one working day. +2. **Normal** – an issue that inhibits the core user experience but does not result in a direct loss of revenue. We aim to respond within five working days. + +### How we’ll respond + +When we respond to your support request, we will do so with one or more of the following: + +- A resolution +- A potential workaround +- A request for more information