mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
Docs: Update issue template to be **better**
This commit is contained in:
parent
865c0c79db
commit
bd18aee43c
14
.github/ISSUE_TEMPLATE.md
vendored
14
.github/ISSUE_TEMPLATE.md
vendored
@ -1,16 +1,20 @@
|
||||
##### Issue type
|
||||
Bug report? Feature request? Other?
|
||||
<!--- Uncomment one of the two options below. -->
|
||||
|
||||
<!--- - Bug report -->
|
||||
<!--- - Feature request -->
|
||||
|
||||
##### 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
|
||||
*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
|
||||
- **Operating System** :
|
||||
- **OBS Studio version** :
|
||||
- **obs-websocket 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.*
|
||||
<!--- 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 does not apply. -->
|
||||
|
@ -12,13 +12,13 @@ Localization happens on [Crowdin](https://crowdin.com/project/obs-websocket)
|
||||
|
||||
### 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 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)
|
||||
|
||||
@ -43,6 +43,11 @@ if (!success) {
|
||||
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
|
||||
|
||||
- Commits follow the 50/72 standard:
|
||||
|
Loading…
x
Reference in New Issue
Block a user