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 Contributing Guidelines

Browse Source
This commit is contained in:
Stéphane L 2017-05-31 15:29:23 +02:00 committed by GitHub
parent a8c36d7366
commit 4506b46ba0
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/CONTRIBUTING.md vendored
View File

@ -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 - Function and variable names: snake_case for C names, CamelCase for C++ names
- Tabs are 8 columns wide - Tabs are 8 columns wide
- 80 columns max. - 80 columns max.
##### Commit Guidelines #### Commit Guidelines
- Commits follow the 50/72 standard: - Commits follow the 50/72 standard:
- 50 characters max for the title - 50 characters max for the title
- One empty line after the title - One empty line after the title
@ -13,4 +19,4 @@
- Prefix the title with a "scope" name - Prefix the title with a "scope" name
- e.g: "CI: fix wrong behaviour when packaging for OS X" - e.g: "CI: fix wrong behaviour when packaging for OS X"
- Typical scopes: CI, General, Request, Event, Server - Typical scopes: CI, General, Request, Event, Server
- Look at existing commits for more examples - Look at existing commits for more examples