diff options
| author | Silvio Rhatto <rhatto@riseup.net> | 2013-12-22 12:11:54 -0200 |
|---|---|---|
| committer | Silvio Rhatto <rhatto@riseup.net> | 2013-12-22 12:11:54 -0200 |
| commit | e8c773aa03892bc905eefe8831c04b67c7978f6a (patch) | |
| tree | 1807a63ea0213e1bfc92573e3d1cd5e1ed9f6062 /GUIDELINES.mdwn | |
| parent | 94e278671116bf229dca6932e0d6d1d7fc4edefc (diff) | |
| download | firma-e8c773aa03892bc905eefe8831c04b67c7978f6a.tar.gz firma-e8c773aa03892bc905eefe8831c04b67c7978f6a.tar.bz2 | |
Misc cleanup
Diffstat (limited to 'GUIDELINES.mdwn')
| -rw-r--r-- | GUIDELINES.mdwn | 113 |
1 files changed, 54 insertions, 59 deletions
diff --git a/GUIDELINES.mdwn b/GUIDELINES.mdwn index fa9568e..0180ef4 100644 --- a/GUIDELINES.mdwn +++ b/GUIDELINES.mdwn @@ -1,62 +1,57 @@ 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 - +This policy helps control all development steps to keep a clean and junk-free +code. In the future this procedure can be automatic. + +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. + +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. + +Used 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 |