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 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.* diff --git a/PROTOCOL.md b/PROTOCOL.md index 3e179a66..d02534f5 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.