-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #83 from etchteam/docs/support-and-issues
docs: support page and issue templates
- Loading branch information
Showing
3 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 [[email protected]](mailto:[email protected]) 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 |