Web Development

Revision as of 05:17, 2 February 2009

Here we'll attempt to explain the process we'll be using to develop the next generation of the DareNET web site. We will rely heavily on community interaction, whether through the forums or on IRC (#dev). IRC is perhaps the best place to find members of the development team and discuss ideas, latest code and make general comments.

We'll maintain 3 version of the site.

stable - for production (the version used on the main site) where stability is more important than features.
trunk - development version where features are important and stability is necessary.
branches - for testing, and development members interested in the most advanced feature set and willing to refine them some.

In This Guide:

1 Coding Standards

Coding Standards

Adding New Features

No new features should be added to stable or trunk, without having their own tests - which should be passed before committing them to the repository.

Indentation

One tab will be used for indentation.

So, indentation should look like this:

<?php
// base level
    // level 1
        // level 2
    // level 1
// base level
?>

Or:

$booleanVariable = true;
$stringVariable = "moose";
if ($booleanVariable) {
	echo "Boolean value is true";
	if ($stringVariable == "moose") {
		echo "We have encountered a moose";
	}
}

Function Calls

Functions should be called without space between function's name and starting bracket. There should be one space between every parameter of a function call.

<?php
$var = foo($bar, $bar2, $bar3);
?>

As you can see above there should be one space on both sides of equals sign (=). To increase the readability of the code you can add spaces (or tabs) before the equals sign, but only in the case of a multiple function call presented below:

<?php
$varShort	 = foo($bar1);
$variableLong	 = foo($bar1);
?>

@@ Line 3: / Line 3: @@
 We'll maintain 3 version of the site.
-* stable - for production (the version used on the main site) where stability is more important than features.
+* '''stable''' - for production (the version used on the main site) where stability is more important than features.
-* trunk - development version where features are important and stability is necessary.
+* '''trunk''' - development version where features are important and stability is necessary.
-* branches - for testing, and development members interested in the most advanced feature set and willing to refine them some.
+* '''branches''' - for testing, and development members interested in the most advanced feature set and willing to refine them some.
+== Coding Standards ==
+=== Adding New Features ===
+No new features should be added to stable or trunk, without having their own tests - which should be passed before committing them to the repository.
+=== Indentation ===
+One tab will be used for indentation.
+So, indentation should look like this:
+<pre>
+<?php
+// base level
+    // level 1
+        // level 2
+    // level 1
+// base level
+?>
+</pre>
+Or:
+<pre>$booleanVariable = true;
+$stringVariable = "moose";
+if ($booleanVariable) {
+	echo "Boolean value is true";
+	if ($stringVariable == "moose") {
+		echo "We have encountered a moose";
+	}
+}</pre>
+===Function Calls===
+Functions should be called without space between function's name and starting bracket. There should be one space between every parameter of a function call.
+<pre><?php
+$var = foo($bar, $bar2, $bar3);
+?></pre>
+As you can see above there should be one space on both sides of equals sign (=). To increase the readability of the code you can add spaces (or tabs) before the equals sign, but only in the case of a multiple function call presented below:
+<pre><?php
+$varShort	 = foo($bar1);
+$variableLong	 = foo($bar1);
+?></pre>