Merge branch 'fix-ldoc-set-spacing' of git://github.com/actionless/awesome
[awesome.git] / STYLE
blobdae80937aed9dd003157e6efcd24d791418e1401
1 If you intend to patch and contribute to awesome, please respect the
2 following guidelines.
4 Imitate the existing code style. For concrete rules:
6  - Use 4 spaces indentation, do not use tabulator characters;
8  - Place braces alone on new lines, and do not place braces for single
9    line statement where it is not needed, i.e no:
10    if(bla) {
11        x = 1;
12    }
14  - Do not put a space after if, for, while or function call statements;
16  - The preferred line length is 80 characters;
18  - Use /* */ for comments;
20  - Use the API: there's a list of a_*() function you should use instead
21    of the standard libc ones. There is also common API for linked list,
22    tabulars, etc;
24  - Be clear in what you do;
26  - Prefix your function name with the module they are enhancing,
27    i.e. if you add a function to manipulate a tag prefix it with tag_.
29  - Write documentation for any new functions, options, whatever.
31 A vim modeline is set in each file to respect this.