added develeopment guide including one first guideline wrt lua vs. sh usage

This commit is contained in:
Christof Schulze 2016-11-28 16:22:22 +01:00
parent 6ebf7120df
commit ed7d6d4a5c

View File

@ -47,3 +47,12 @@ and you can try rebasing it onto the new `base` branch yourself and after that c
Always call `make update-patches` after making changes to a module repository as `make update` will overwrite your
commits, making `git reflog` the only way to recover them!
Development Guidelines
----------------------
lua should be used instead of sh whenever sensible. The following criteria
should be considered:
- Is the script doing more than just executing external commands? if so, use lua
- Is the script parsing/editing json-data? If so, use lua for speed