aboutsummaryrefslogtreecommitdiff
path: root/GUIDELINES.md
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2017-10-01 17:22:17 -0300
committerSilvio Rhatto <rhatto@riseup.net>2017-10-01 17:22:17 -0300
commitb3e16e98ddd37a0658b50aaa52e89fdab55d34cf (patch)
tree259d9e7e89fbf3f05a8f82e34d099f73b689eec5 /GUIDELINES.md
parent43d97ef4af429d3fe5fc8edfbfe668569833b426 (diff)
downloadfirma-b3e16e98ddd37a0658b50aaa52e89fdab55d34cf.tar.gz
firma-b3e16e98ddd37a0658b50aaa52e89fdab55d34cf.tar.bz2
Change markdown extension to .md
Diffstat (limited to 'GUIDELINES.md')
-rw-r--r--GUIDELINES.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/GUIDELINES.md b/GUIDELINES.md
new file mode 100644
index 0000000..0180ef4
--- /dev/null
+++ b/GUIDELINES.md
@@ -0,0 +1,57 @@
+Firma Development Policy
+------------------------
+
+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