mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2024-12-27 15:36:29 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Drew DeVault 2015-11-27 09:18:46 -05:00
parent 1e753e3a74
commit 87e3778125
1 changed files with 118 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CONTRIBUTING.md
View file

@ -9,7 +9,8 @@ your plans.
Sway is written in C. The style guidelines is [kernel
style](https://www.kernel.org/doc/Documentation/CodingStyle), but all braces go
on the same line (*"but K&R!" is silly*). Some points to note:
on the same line (*"but K&R says so!" is a silly to justify something*). Some
points to note:
* Do not use typedefs unless you have a good reason
* Do not use macros unless you have a *really* good reason
@ -19,6 +20,8 @@ on the same line (*"but K&R!" is silly*). Some points to note:
* Use logging with reckless abandon
* Always include braces for if/for/while/etc, even for one-liners
An example of well formatted code:
```C
#include <stdio.h>
#include <stdlib.h>