Changeset 767 for trunk/docs/coding_standards.txt

Timestamp:

Jun 7, 2022 6:41:24 AM (23 months ago)

Author:

anonymous

Message:

Add App param ‘template_ext’ used to inform services where to find header and footer templates. Minor fixes.

File:

• trunk/docs/coding_standards.txt (modified) (4 diffs)

trunk/docs/coding_standards.txt

@@ -11 +11 @@
 Essential reading:
 http://pear.php.net/manual/en/standards.php
+
+
+=====================================================================
+General guidelines
+=====================================================================
+
+- Respect these coding styles.
+- Don't add npm dependencies if you can avoid it. If a new dependency is unavoidable, be mindful of its size, freshness and added value.
+- Use Svelte for all UI needs.
+- Try to not shoehorn your code into existing functions or components.
+- Simple is better. OOP is not inevitable. Simple functions often work as well, if not better.
+- If you must use OOP, avoid inheritance as much as possible, no one likes digging several layers of abstraction.
+- Comment the code. What, why, how, just make your intent clear.
 
 
@@ -45 +58 @@
 
 Use an indent of 4 spaces, with no tabs. Code and especially comments should
-usually be wrapped <= 80 characters. Exceptions are made in the case where 
+usually be wrapped <= 80 characters. Exceptions are made in the case where
 code readability is significantly improved with longer lines.
 
@@ -224 +237 @@
     {
         $app =& App::getInstance();
-    
+
         // If an array, check values recursively.
         if (is_array($email)) {
@@ -284 +297 @@
 All code should work with register_globals = Off. This means using
 $_REQUEST, $_GET, $_POST, $_COOKIE, $_SESSION, $_SERVER, and $_ENV
-to access all request, get, post, cookie, session, server, and 
+to access all request, get, post, cookie, session, server, and
 environment data, respectively.