From 4506b46ba0bf2212c0acf04b6adc283fbdda81b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20L?= Date: Wed, 31 May 2017 15:29:23 +0200 Subject: [PATCH] Docs: update Contributing Guidelines --- .github/CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) 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