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

CONTRIBUTING: Update standards

Browse Source 
Update some links and standards with what we've been using
This commit is contained in:
tt2468 2021-11-17 01:32:37 -08:00
parent 0f17d3d6f8
commit 32e4ad74b7
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -29,21 +29,20 @@ These are required to automatically generate the [protocol specification documen
* Favor return-early code and avoid wrapping huge portions of code in conditionals. As an example, this: * Favor return-early code and avoid wrapping huge portions of code in conditionals. As an example, this:
```cpp ```cpp
if (success) { if (success)
return RequestResult::Success(); return RequestResult::Success();
} else { else
return RequestResult::Error(RequestStatus::GenericError); return RequestResult::Error(RequestStatus::GenericError);
}
``` ```
is better like this: is better like this:
```cpp ```cpp
if (!success) { if (!success)
return RequestResult::Error(RequestStatus::GenericError); return RequestResult::Error(RequestStatus::GenericError);
}
return RequestResult::Success(); return RequestResult::Success();
``` ```
* Try to use the [built-in](https://github.com/Palakis/obs-websocket/blob/master/src/requesthandler/rpc/Request.h) request checks when possible. * Try to use the [built-in](https://github.com/obs-websocket/obs-websocket/blob/master/src/requesthandler/rpc/Request.h) request checks when possible.
* Refer to existing requests for usage examples. * Refer to existing requests for usage examples.
* Some example common response/request property names are: * Some example common response/request property names are:
@ -54,12 +53,14 @@ return RequestResult::Success();
* Response parameters which have no attributed data due to an invalid state should be set to `null` (versus being left out) * Response parameters which have no attributed data due to an invalid state should be set to `null` (versus being left out)
* For example, when `GetSceneList` is called and OBS is not in studio mode, `currentPreviewSceneName` will be `null` * For example, when `GetSceneList` is called and OBS is not in studio mode, `currentPreviewSceneName` will be `null`
* If a request's core response data depends on a state, an error should be thrown unless `ignoreNonFatalRequestChecks` is set. See `GetCurrentPreviewScene` as an example. * If a request's core response data depends on a state, an error should be thrown. See `GetCurrentPreviewScene` as an example.
* In general, try to match the style of existing code as best as possible. We try our best to keep a consistent code style, and may suggest nitpicks as necessary.
### Commit Guidelines ### Commit Guidelines
* Commits follow the 50/72 standard: * Commits follow the 50/72 standard:
* 50 characters max for the commit title (excluding scope name) * 50 characters suggested max for the commit title (absolute maximum 72 including scope)
* One empty line after the title * One empty line after the title
* Description wrapped to 72 columns max width per line. * Description wrapped to 72 columns max width per line.