From cfa0904afc40e1f5f075827011c599b5c79e6ba7 Mon Sep 17 00:00:00 2001 From: Silvio Rhatto Date: Tue, 28 May 2013 12:37:13 -0300 Subject: Wikifying guidelines --- GUIDELINES | 62 --------------------------------------------------------- GUIDELINES.mdwn | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+), 62 deletions(-) delete mode 100644 GUIDELINES create mode 100644 GUIDELINES.mdwn diff --git a/GUIDELINES b/GUIDELINES deleted file mode 100644 index fa9568e..0000000 --- a/GUIDELINES +++ /dev/null @@ -1,62 +0,0 @@ -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 - 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 + -- cgit v1.2.3