From 9b8bcabd4e5cb8c7d6bc9230287ef733aab3327d Mon Sep 17 00:00:00 2001 From: Martin Winkler Date: Sun, 29 May 2022 18:42:15 +0200 Subject: [PATCH] WIP development notes --- DEVELOPMENT.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 DEVELOPMENT.md diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..fe57a0b --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,41 @@ +# Naming convention + +- [ ] Sequencer internal variables which are only used inside sequencer + +* lower case +* prefix `_sqr_` + +- [ ] Sequencer "global" variables which can be also used in seqs + +* lower case +* prefix `sqr_` + +- [ ] Sequencer provides some global seq related variables + +* lower case +* prefix `seq_` or internal use `_seq_` + +For variables inside seqs it is recommended to be prefixed with `sq_[SEQ SHORT]` + +e.g. for nextcloud.sh +`sq_ncinstallDir="/var/www/nextcloud"` + +For seq configuration variables it is recommended to prefix them with `sc_[SEQ SHORT]` + +e.g. for nextcloud.cfg(.example) +`sc_ncinstallDir="/var/www/nextcloud"` + +# Indentation + +Sequencer.sh and all seqs use the following indentation rules + +* indent style: space +* indent size : 2 + +# Auto indentation + +Please use the seq `vim.sh setup` to: + +* configure vim for auto indentation +* install vim indent script for .sh files +* install [editorconfig](https://github.com/editorconfig/editorconfig-vim)