From ed7d6d4a5ce4e949e8408cd04532d40a171c40a7 Mon Sep 17 00:00:00 2001 From: Christof Schulze Date: Mon, 28 Nov 2016 16:22:22 +0100 Subject: [PATCH] added develeopment guide including one first guideline wrt lua vs. sh usage --- docs/dev/basics.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/dev/basics.rst b/docs/dev/basics.rst index acb66fa3..54febc30 100644 --- a/docs/dev/basics.rst +++ b/docs/dev/basics.rst @@ -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 +