From a8c36d73665018f4bc5c3fe0ff46da14442dfdfc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20L?= Date: Wed, 31 May 2017 15:24:58 +0200 Subject: [PATCH 1/3] Docs: add issue template --- .github/ISSUE_TEMPLATE.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..61eea318 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,18 @@ +#### Issue type +- [ ] Bug +- [ ] Feature request +- [ ] Other + +#### Description +*Replace this with a description of the bug encountered or feature requested.* + +#### Steps to reproduce +*If it's a bug, please describe the steps to reproduce it. Otherwise, remove this section.* + +#### Technical information +- **Operating System** : +- **OBS Studio version** : + +#### Development Environment +*If you're trying to compile obs-websocket, please describe your compiler type and version (e.g: GCC 4.7, VC2013, ...), and the CMake settings used. +Remove this section if it doesn't apply to your case.* From 4506b46ba0bf2212c0acf04b6adc283fbdda81b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20L?= Date: Wed, 31 May 2017 15:29:23 +0200 Subject: [PATCH 2/3] Docs: update Contributing Guidelines --- .github/CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8d369314..ea45e450 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,9 +1,15 @@ -##### Coding Guidelines +## Contributing to obs-websocket + +### Translating obs-websocket to your language +Localization happens on Crowdin: https://crowdin.com/project/obs-websocket + +### Writing code for obs-websocket +#### Coding Guidelines - Function and variable names: snake_case for C names, CamelCase for C++ names - Tabs are 8 columns wide - 80 columns max. -##### Commit Guidelines +#### Commit Guidelines - Commits follow the 50/72 standard: - 50 characters max for the title - One empty line after the title @@ -13,4 +19,4 @@ - Prefix the title with a "scope" name - e.g: "CI: fix wrong behaviour when packaging for OS X" - Typical scopes: CI, General, Request, Event, Server - - Look at existing commits for more examples \ No newline at end of file + - Look at existing commits for more examples From d0a90ecea42afa6b4de02aaef18037c6e4396e87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20L?= Date: Tue, 6 Jun 2017 00:54:32 +0200 Subject: [PATCH 3/3] Update PROTOCOL.md --- PROTOCOL.md | 1 + 1 file changed, 1 insertion(+) diff --git a/PROTOCOL.md b/PROTOCOL.md index 99909305..f6eab512 100644 --- a/PROTOCOL.md +++ b/PROTOCOL.md @@ -1,5 +1,6 @@ obs-websocket 4.1 protocol reference ================================ +**This is the reference for the latest 4.1 developement build. [See here for obs-websocket 4.0.0!](https://github.com/Palakis/obs-websocket/blob/4.0.0/PROTOCOL.md)** ## General Introduction Messages exchanged between the client and the server are JSON objects.