summaryrefslogtreecommitdiffstats
path: root/CODING
diff options
context:
space:
mode:
Diffstat (limited to 'CODING')
-rw-r--r--CODING38
1 files changed, 38 insertions, 0 deletions
diff --git a/CODING b/CODING
new file mode 100644
index 00000000..95093915
--- /dev/null
+++ b/CODING
@@ -0,0 +1,38 @@
1The following guidelines are intended to aid programmers in creating
2code that is consistent with the existing core plugins.
3
4The primary goals of these standards are internal consistency, and
5readability in a wide range of environments.
6
71. C Language Programming
8
9All code should comply with the requirements of the Free Software
10Foundation Coding standards (which are currently available at
11http://www.gnu.org/prep/standards_toc.html). We also follow most of
12the FSF guidelines. Developers may suggest deviations from the FSF
13style recommendations, which will be considered by open discussion on
14the netsaintplug-devel mailing list. Any such deviations will apply to
15the entire code base to ensure consistency.
16
17Currently, the exceptions to FSF recommendatios are roughly equivalent
18to GNU indent with invoked as 'indent -ts 2 -br'. Specifically, the
19exceptions are as follows:
20
21a) leading white space for a statement should be formatted as tabs,
22with one tab for each code indentation level.
23
24b) in statement continuation lines, format whitespace up to the column
25starting the statement as tabs, format the rest as spaces (this
26results in code that is legible regardless of tab-width setting).
27
28c) with the exception of the above, tabs should generally be avoided
29
30d) when tab width is 2 spaces, line-length should not exceed 80
31characters
32
33e) The opening brace of an if or while block is on the same line as
34the end of the conditional expression (the '-br' option).
35
362. Perl Language Programming
37
38<To Be Written>