diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6183f05ef..8847f0c2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,6 +120,18 @@ Your contributions should be bundled with related documentation to help users un When you contribute code to Netdata, you are automatically accepting that you will be responsible for maintaining that code in the future. So, if users need help, or report bugs, we will invite you to the related github issues to help them or fix the issues or bugs of your contributions. +#### Code Style + +The single most important rule when writing code is this: *check the surrounding code and try to imitate it*. [Reference](https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en) + +We use several different languages and have had contributions from several people with different styles. When in doubt, you can check similar existing code. + +For C contributions in particular, we try to respect the [Linux kernel style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html), with the following exceptions: + - Use 4 space indentation instead of 8 + - We occassionally have multiple statements on a single line (e.g. `if (a) b;`) + - Allow max line length of 120 chars + - Allow opening brace at the end of a function declaration: `function() {`. + ### Your first pull request There are several guides for pull requests, such as the following: |