Wikifying guidelines

1 files changed, 62 insertions, 0 deletions

diff --git a/GUIDELINES.mdwn b/GUIDELINES.mdwn
new file mode 100644
index 0000000..fa9568e
--- /dev/null
+++ b/GUIDELINES.mdwn
@@ -0,0 +1,62 @@
+Firma Development Policy
+------------------------
+
+Abstract: this policy helps control all development
+          steps to keep a clean and junk-free code.
+
+In the future this procedure will be automatic.
+
+1 - After any addition to firma, check the following:
+----------------------------------------------------
+
+  - If a new variable has to be declared via a config-file,
+    remember to set it to be created in the NewList function.
+
+  - Put all new functions in the FUNCTIONS variable.
+
+  - Put all new global variables in the GLOBAL_VARS variable.
+
+  - If you are using an unix command, check if it's already
+    listed in the commands list bellow. If it's not, please
+    add it.
+
+2 - Variables usage
+-------------------
+
+  - Global vars: uppercase, with spaces replaced by underscores.
+
+  - Local vars: lowercase, with spaces replaced by underscores and
+                declared using "local".
+
+  - Attention to variables initialization, unset all vars after use.
+
+3 - Used unix commands
+----------------------
+
+   bash itself
+
+   $GPG_BINARY
+   $MAIL_AGENT
+
+   basename
+   chmod
+   chown
+   cut
+   echo
+   expect
+   fold
+   grep
+   head
+   logger
+   mkdir
+   mv
+   rm
+   sed
+   sha1sum
+   sleep
+   sort
+   touch
+   tr
+   uniq
+   wc
+