add coding tips for developers
authorchriskl <chriskl>
Mon, 17 Mar 2003 08:53:17 +0000 (08:53 +0000)
committerchriskl <chriskl>
Mon, 17 Mar 2003 08:53:17 +0000 (08:53 +0000)
DEVELOPERS

index 6809bf412111c715315cb4d11c2713acd1983d4a..429e89ce52f0c4f02f2373881302adb0b9e340f2 100644 (file)
@@ -51,3 +51,26 @@ DEVELOPER INFO
   contributed something useful to phpPgAdmin.  If you're interested in that, 
   please contact us.                                  
                                  
+TIPS FOR DEVELOPERS
+-------------------
+
+When you submit code to phpPgAdmin, we do expect it to adhere to the existing
+coding standards in the source.  So, instead of using your personal favourite
+code layout style, please format it to look like surrounding code.
+
+Test your code properly!  Say you are developing a feature to create domains.
+Try naming your domain all of the following:
+
+       * "
+       * '
+       * \
+       * words with spaces
+       * <br><br><br>
+
+If you are adding a new class function, be sure to use the "clean",
+"fieldClean", "arrayClean" and "fieldArrayClean" functions to properly escape
+odd characters in user input.  Examine existing functions that do similar
+things to yours to get yours right.
+
+
+