Skip to content

Commit c0b0c68

Browse files
ChristopheCVBTinaTielPjiesco
authored
Issue forms (#129)
* Copied over short repo transfer notice from 5.x.x/develop branch * docs: Correcting typo * Create issue templates * fix: requested changes * Change missing-event issue template to new Issue Form * Change missing-request issue template to new Issue Form Co-authored-by: TinaTiel <[email protected]> Co-authored-by: Pjiesco <[email protected]> Co-authored-by: Pjiesco <[email protected]>
1 parent e86e9f7 commit c0b0c68

File tree

4 files changed

+146
-0
lines changed

4 files changed

+146
-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.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Missing Event
2+
description: Request Implementation of a missing event
3+
labels: [ "missing event" ]
4+
5+
body:
6+
- type: input
7+
id: eventName
8+
attributes:
9+
label: Event Name
10+
description: Name of the event
11+
placeholder: SceneCreated
12+
validations:
13+
required: true
14+
15+
- type: input
16+
id: docLink
17+
attributes:
18+
label: Documentation
19+
description: Link to the Event Documentation
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: eventFields
25+
attributes:
26+
label: Event Fields
27+
description: |
28+
Fields send with the Event
29+
30+
Tip: Use the given example table to list the fields
31+
value: |
32+
| Name | Type |
33+
| ------------- | :-------------: |
34+
| `exampleField` | String |
35+
| `exampleField2` | int |
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: additional-info
41+
attributes:
42+
label: Additional Info
43+
description: Other usefull information like links to a Event handler etc.

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

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Missing Request
2+
description: Request implementation of a missing request
3+
labels: [ "missing request" ]
4+
5+
body:
6+
- type: input
7+
id: requestName
8+
attributes:
9+
label: Request Name
10+
description: Name of the request
11+
placeholder: GetVersion
12+
validations:
13+
required: true
14+
15+
- type: input
16+
id: docLink
17+
attributes:
18+
label: Documentation
19+
description: Link to the Request Documentation
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: requestParameters
25+
attributes:
26+
label: Request Parameters
27+
description: |
28+
Tip: Use the given example table to list the parameters
29+
value: |
30+
| Name | Type | Required |
31+
| ------------- | :-------------: | :-------------: |
32+
| `exampleParameter` | String | yes |
33+
| `exampleParameter2` | int | no |
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: responseParameters
39+
attributes:
40+
label: Response Parameters
41+
description: |
42+
Tip: Use the given example table to list the parameters
43+
value: |
44+
| Name | Type |
45+
| ------------- | :-------------: |
46+
| `exampleResponse` | String |
47+
| `exampleResponse2` | int |
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: additional-info
53+
attributes:
54+
label: Additional Info
55+
description: Other usefull information like links to a Request handler etc.

Diff for: README.md

+26
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,32 @@ The current version of the library (2.0.0+) is published under `io.obs-websocket
170170

171171
There are several key differences to be aware of, for full details please see the [current protocol](https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md) for Palakis OBS Websocket.
172172

173+
### 📘 Notice to Developers: Repository Transfer 📘
174+
On June 21st, 2021, this repository was transferred from the `Twasi` Organization to the
175+
`obs-websocket-community-projects` Organization. This was done to better align this library with the
176+
greater Palakis' OBS Websocket plugin community, and provide better administrative tools.
177+
178+
Remotes will continue to operate as normal, due to GitHub automatic redirects. However, to avoid
179+
confusion GitHub strongly recommends you update those remotes.
180+
181+
If you haven't updated your remote, you can check like so; the below example shows an old remote:
182+
```
183+
C:\Users\...\websocket-obs-java>git remote -v
184+
origin https://github.com/Twasi/websocket-obs-java.git (fetch)
185+
origin https://github.com/Twasi/websocket-obs-java.git (push)
186+
```
187+
You can update and verify your remote is correct like this:
188+
```
189+
C:\Users\...\websocket-obs-java>git remote set-url origin https://github.com/obs-websocket-community-projects/websocket-obs-java.git
190+
(no output)
191+
C:\Users\...\websocket-obs-java>git remote -v
192+
origin https://github.com/obs-websocket-community-projects/websocket-obs-java.git (fetch)
193+
origin https://github.com/obs-websocket-community-projects/websocket-obs-java.git (push)
194+
```
195+
See [Transferring a repository](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/transferring-a-repository)
196+
for more information.
197+
198+
173199
### Requests, Events, and Subscriptions
174200
Most events and requests changed between the two libraries, due to changes in the OBS Websocket protocol. You can view the [current protocol](https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md) for the full list of available requests and events.
175201

0 commit comments

Comments
 (0)