RULES
-----

$Id: RULES,v 1.1.1.1 2002/04/01 22:40:15 jbcombes Exp $

Here are some rules you should try to follow when you develop daCode.

* Any class name should have its first caractere in upper case like:
	Class Config {
	}

* Use an upper case "F" when you create a new function. Just like this:
	Function debug {
	}

* To indent the code, use tabs, not spaces. Please.

* On the other and, to indent the ChangeLog, only use spaces, never tabs.
  Look at how the ChangeLog is made before writing any entry.

* No space after between functions and "(", and no space between "(" and
  the inside args. No more before ")".
  
  On the other hand, add a space after control structures like if, else, 
  elseif, while, for, echo, return ...

* Please use simple quotes instead of double quotes around the html output 
  as much as you can. Basically, you only need double quotes when you have 
  escaping characters like "\n", "\r", "\t" and variables in your code.
  But don't put variable between quotes (simple or double), just put them 
  outside by concatenating them to the strings.

* Any SQL request should be made by dbmysql.php3 (and also dbpgsql.php3)
  library

* All the configuration should go in config.php3. There is a config class, this
  is the one you should use.

* If you are away for more than 5 days, or do not respond to others developers
  need in that time which can't continue to develop because they wait for your
  anwser, you allow them to modify the code you usually maintain. Please take
  care to synchronize when you are back.

* Before you modify any file, please take care to run a 'cvs update' to be sure
  noone modified the file before.

* Please understand not everyone has a 1600x1200 terminal. So stick to a 
  maximum of 80 caracteres per lines. ':set tw=80' should be fine under vim.

* Use CAPS everytime you use SQL commands. It will be much easier later
  to modify the code. On the other hand, HTML code must be written with
  lowercase letters to satisfy the latest w3c recommandations. Please only use 
  XHTML 1.0 (transitional, or better, strict) code.

* Any static sentence/words should be print through lecho command. See
  lang.php3. This way it will be much easier to translate to a new/another
  language.

* AUTHORS is for the authors, CREDITS for the contributors.

* Try to always document your functions with PHPDoc (http://www.phpdoc.de/)

* Always add the CVS "Id" tag ("Id" between two "$") in the header of
  your files.
