From 6008f2d28266f9a5ca1c49bccea4a3a0766105f7 Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Sun, 11 Oct 2009 16:17:35 +0000
Subject: Added coding styles and changes documents.

git-svn-id: http://code.elgg.org/elgg/trunk@3526 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 CODING.txt | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 CODING.txt

(limited to 'CODING.txt')

diff --git a/CODING.txt b/CODING.txt
new file mode 100644
index 000000000..a3b92096f
--- /dev/null
+++ b/CODING.txt
@@ -0,0 +1,38 @@
+These are the coding standards for Elgg.  All core development, bundled 
+plugins, and tickets attached to Trac are expected to be in this format.
+
+* Unix line endings
+* Hard tabs, 4 character tab spacing.
+* No shortcut tags ( <? or <?= or <% )
+* PHPDoc comments on functions and classes (including methods and declared 
+  members).
+* Mandatory wrapped {}s around any code blocks. 
+	Bad:
+	if (true)
+		foreach($arr as $elem)
+			echo $elem;
+
+	Good:
+	if (true) {
+		foreach($arr as $elem) {
+			echo $elem;
+		}
+	}
+* Name functions and methods using underscore_character().
+* Name classes using CamelCase()
+* Name globals and constants in ALL_CAPS (FALSE, TRUE, NULL, ACCESS_FRIENDS, 
+  $CONFIG).
+* Space functions like_this($required, $optional = TRUE)
+* Space keywords and constructs like this: if (false) { ... }
+* Include variables in strings with double quotes instead of concatenating:
+	Bad: 
+	echo 'Hello, ' . $name . '!  How are you?';
+	
+	Good:
+	echo "Hello, $name!  How are you?"; 
+	
+* Line lengths should be reasonable.  If you are writing lines over 100 
+  characters, please revise the code.
+* Use slash-style comments. (// and /* */)
+* Preferred no closing ?> tag at EOF. (Avoids problems with trailing 
+  whitespace.)
-- 
cgit v1.2.3