Skip to content

Commit 8315933

Browse files
author
TinaTiel
authored
Merge pull request #62 from obs-websocket-community-projects/Issue_Templates
Create issue templates
2 parents 662eb73 + d5945f2 commit 8315933

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Bug report
3+
about: Report a bug to help us improve
4+
title: "SHORT DESCRIPTION"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
# Describe the bug
11+
A clear and concise description of what the bug is.
12+
13+
# Code Sample
14+
```java
15+
// give a code sample showing how to reproduce this.
16+
```
17+
18+
# Expected behavior
19+
A clear and concise description of what you expected to happen.
20+
21+
# Additional context
22+
Add any other context about the problem here.

Diff for: .github/ISSUE_TEMPLATE/missing-event.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Missing Event
3+
about: Request Implementation of a missing event
4+
title: 'EVENT NAME'
5+
labels: missing event
6+
assignees: ''
7+
8+
---
9+
10+
# Event Name
11+
Please give the name of the event.
12+
13+
# Documentation
14+
[Event Protocol Documentation](https://github.com/Palakis/obs-websocket/.../protocol.md#anchor)
15+
16+
## Event Fields
17+
| Name | Type |
18+
| ------------- | :-------------: |
19+
| `exampleField` | String |
20+
| `exampleField2` | int |
21+
22+
# Additional Information
23+
If you have any additional information like a link to any documentation or event handler of this event please provide this here.

Diff for: .github/ISSUE_TEMPLATE/missing-request.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Missing Request
3+
about: Request implementation of a missing request
4+
title: 'REQUEST NAME'
5+
labels: missing request
6+
assignees: ''
7+
8+
---
9+
10+
# Request Name
11+
Please give the name of the request.
12+
13+
# Documentation
14+
[Request Protocol Documentation](https://github.com/Palakis/obs-websocket/.../protocol.md#anchor)
15+
16+
## Request Parameters**
17+
| Name | Type | Required |
18+
| ------------- | :-------------: | :-------------: |
19+
| `exampleParameter` | String | yes |
20+
| `exampleParameter2` | int | no |
21+
22+
## Response Parameters**
23+
| Name | Type |
24+
| ------------- | :-------------: |
25+
| `exampleResponse` | String |
26+
| `exampleResponse2` | int |
27+
28+
# Additional Information
29+
If you have any additional information like a link to any documentation or request handler of this request please provide this here.

0 commit comments

Comments
 (0)