Openstatus
www.openstatus.dev
chore: issue, PR templayes (#387)
authored by
Wilfred Almeida
and committed by
GitHub
2c7bcc91
67280335
+167
+80
.github/workflows/ISSUE_TEMPLATE/bug_report.yml
+80
.github/workflows/ISSUE_TEMPLATE/bug_report.yml
···
1
+
name: "🐛 Bug Report"
2
+
description: Report a bug for OpenStatus.
3
+
labels:
4
+
- "needs-triage"
5
+
- "bug"
6
+
body:
7
+
- type: markdown
8
+
attributes:
9
+
value: |
10
+
## Welcome 👋🏻
11
+
12
+
Thank you for taking the time to report an issue with OpenStatus. Please fill out the information below to help us resolve your issue faster. If you have a question or need general help, please join our [Discord community](https://www.openstatus.dev/discord).
13
+
- type: checkboxes
14
+
attributes:
15
+
label: Preliminary Checks
16
+
description: Please make sure that you verify each checkbox and follow the instructions for them.
17
+
options:
18
+
- label: |
19
+
I have reviewed the documentation: https://docs.openstatus.dev/
20
+
required: true
21
+
- label: |
22
+
I have searched for existing issues: https://github.com/openstatusHQ/openstatus/issues
23
+
required: true
24
+
- label: |
25
+
This issue is not a question, general help request, or anything other than a bug report directly related to OpenStatus. Please ask questions in our Discord community: https://www.openstatus.dev/discord
26
+
required: true
27
+
- type: input
28
+
id: reproduction-link
29
+
attributes:
30
+
label: Reproduction / Replay Link (Optional)
31
+
placeholder: "https://github.com/username/repository-name/"
32
+
description: |
33
+
Link to a minimal reproduction (GitHub repository, CodeSandbox, StackBlitz, etc.) or a [Replay recording](https://www.replay.io/).
34
+
35
+
**Do not link to your actual project**, but provide a minimal reproduction in a fresh project.
36
+
37
+
Instructions:
38
+
- [How to record a Replay](https://docs.replay.io/bug-reports/recording-a-replay)
39
+
validations:
40
+
required: false
41
+
- type: textarea
42
+
attributes:
43
+
label: Description
44
+
description: Describe the issue that you're seeing.
45
+
value: |
46
+
<!-- Be as precise as you can. Feel free to share screenshots, videos, or data from the devtools of your browser -->
47
+
48
+
**Steps to reproduce:**
49
+
50
+
1. Step 1
51
+
2. Step 2
52
+
53
+
**Expected behavior:**
54
+
55
+
<!-- Describe what you expected to happen -->
56
+
57
+
**Actual behavior:**
58
+
59
+
<!-- Describe what actually happened -->
60
+
validations:
61
+
required: true
62
+
- type: textarea
63
+
attributes:
64
+
label: Environment
65
+
render: Shell
66
+
description: Run "npx envinfo --system --browsers --binaries --npmPackages" in your project directory and paste the output here.
67
+
placeholder: |
68
+
You'll get an output similar to this:
69
+
70
+
System:
71
+
OS: Operating System
72
+
CPU: CPU
73
+
Binaries:
74
+
Node: X
75
+
npm: X
76
+
Browsers:
77
+
Chrome: X
78
+
Edge: X
79
+
validations:
80
+
required: false
+5
.github/workflows/ISSUE_TEMPLATE/config.yml
+5
.github/workflows/ISSUE_TEMPLATE/config.yml
+24
.github/workflows/ISSUE_TEMPLATE/doc_report.yml
+24
.github/workflows/ISSUE_TEMPLATE/doc_report.yml
···
1
+
name: "📚 Documentation request"
2
+
description: Need to report a documentation issue? Please fill out the information below
3
+
title: '[docs]'
4
+
labels: ['documentation']
5
+
body:
6
+
- type: dropdown
7
+
id: type-of-doc-issue
8
+
attributes:
9
+
label: Type of documentation issue
10
+
multiple: true
11
+
options:
12
+
- "Broken Link"
13
+
- "Incorrect Information"
14
+
- "Typo"
15
+
- "Missing Information"
16
+
- "Other"
17
+
validations:
18
+
required: true
19
+
- type: textarea
20
+
attributes:
21
+
label: Describe the problem and the proposed solution
22
+
description: Please describe the change & need of change in as much detail possible.
23
+
validations:
24
+
required: false
+32
.github/workflows/ISSUE_TEMPLATE/feature_request.yml
+32
.github/workflows/ISSUE_TEMPLATE/feature_request.yml
···
1
+
name: "💡 Feature Request"
2
+
description: Describe a new feature or capability you would like to see in OpenStatus' offering.
3
+
labels:
4
+
- "enhancement"
5
+
body:
6
+
- type: markdown
7
+
attributes:
8
+
value: |
9
+
## Welcome 👋🏻
10
+
11
+
Thank you for taking the time to write up a feature request. Please fill out the information below to be able to help you faster. If you have a question or need general help, please join our [Discord community](https://www.openstatus.dev/discord).
12
+
- type: checkboxes
13
+
attributes:
14
+
label: Preliminary Checks
15
+
description: Please make sure that you verify each checkbox and follow the instructions for them.
16
+
options:
17
+
- label: |
18
+
I have reviewed https://docs.openstatus.dev/ for existing features that would solve my problem
19
+
required: true
20
+
- label: |
21
+
I have searched for existing feature requests: https://github.com/openstatusHQ/openstatus/issues
22
+
required: true
23
+
- label: |
24
+
This issue is not a question, general help request, or anything other than a feature request directly related to OpenStatus. Please ask questions in our Discord community: https://discord.com/invite/dHD4JtSfsn.
25
+
required: true
26
+
- type: textarea
27
+
attributes:
28
+
label: Description
29
+
description: Describe the feature or capability you would like to see in OpenStatus' offering.
30
+
placeholder: Make sure it's unique, describe your use case, and explain the problem and proposed solution.
31
+
validations:
32
+
required: true
+26
.github/workflows/pull_request_template.md
+26
.github/workflows/pull_request_template.md
···
1
+
## Type of change
2
+
3
+
<!--- What types of changes does your code introduce? Put an `x` in the box that apply: -->
4
+
5
+
- [ ] 🐛 Bug fix
6
+
- [ ] 🌟 New feature
7
+
- [ ] 🔨 Breaking change
8
+
- [ ] 📖 Refactoring / dependency upgrade / documentation
9
+
10
+
## Description
11
+
12
+
<!--- Describe your changes in detail -->
13
+
14
+
### A picture tells a thousand words (if any)
15
+
16
+
### Before this PR
17
+
18
+
{Please add a screenshot here}
19
+
20
+
### After this PR
21
+
22
+
{Please add a screenshot here}
23
+
24
+
### Related Issue (optional)
25
+
26
+
<!--- Please link to the issue here: -->