Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Update issue template to be **better**

Browse Source
This commit is contained in:
tt2468 2020-05-28 17:00:03 -07:00
parent 865c0c79db
commit bd18aee43c
2 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,16 +1,20 @@
##### Issue type ##### Issue type
Bug report? Feature request? Other? <!--- Uncomment one of the two options below. -->
<!--- - Bug report -->
<!--- - Feature request -->
##### Description ##### Description
*Replace this with a description of the bug encountered or feature requested.* <!--- Describe the bug encountered or feature requested. -->
##### Steps to reproduce and other useful info ##### Steps to reproduce and other useful info
*If it's a bug, please describe the steps to reproduce it and PLEASE include an OBS log file. Otherwise, remove this section.* <!--- If it's a bug, please describe the steps to reproduce it and PLEASE include an OBS log file. Otherwise, remove this section. -->
##### Technical information ##### Technical information
- **Operating System** : - **Operating System** :
- **OBS Studio version** : - **OBS Studio version** :
- **obs-websocket version** :
##### Development Environment ##### 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. <!--- 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.* <!--- Remove this section if it does not apply. -->

9
CONTRIBUTING.md
View File

@ -12,13 +12,13 @@ Localization happens on [Crowdin](https://crowdin.com/project/obs-websocket)
### Code Formatting Guidelines ### Code Formatting Guidelines
- Function and variable names: snake_case for C names, MixedCaps for C++ names - Function and variable names: snake_case for C names, camelCase for C++ method names
- Request and Event names should use MixedCaps names - Request and Event names should use MixedCaps names
- Request and Event json properties should use camelCase. For more detailed info on property naming, see [Google's JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml) - Request and Event json properties should use camelCase. For more detailed info on property naming, see [Google's JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml)
- Tabs are 8 columns wide - Code is indented with Tabs. Assume they are 8 columns wide
- 80 columns max code width. (Docs can be larger) - 80 columns max code width. (Docs can be larger)
@ -43,6 +43,11 @@ if (!success) {
return req->SendOKResponse(); return req->SendOKResponse();
``` ```
- Some example common response/request property names are:
- `sceneName` - The name of a scene
- `sourceName` - The name of a source
- `fromScene` - From a scene - scene name
### Commit Guidelines ### Commit Guidelines
- Commits follow the 50/72 standard: - Commits follow the 50/72 standard: