aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation/chapters
diff options
context:
space:
mode:
Diffstat (limited to 'doc/documentation/chapters')
-rw-r--r--doc/documentation/chapters/contributing.texi15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/documentation/chapters/contributing.texi b/doc/documentation/chapters/contributing.texi
index ed1c19b30..f4493e6c1 100644
--- a/doc/documentation/chapters/contributing.texi
+++ b/doc/documentation/chapters/contributing.texi
@@ -95,14 +95,23 @@ of languages, in order of preference:
95@enumerate 95@enumerate
96@item C 96@item C
97@item Portable Shell Scripts 97@item Portable Shell Scripts
98@item Bash Scripts
99@c Nim ?
100@item Python (@geq{}3.6) 98@item Python (@geq{}3.6)
101@end enumerate 99@end enumerate
102 100
103We welcome efforts to remove our existing python-2.7 scripts to 101We welcome efforts to remove our existing python-2.7 scripts to
104replace them either with Bash or, at your choice, python-3.6+. 102replace them either with portable shell scripts or,
103at your choice, python-3.6+.
105 104
106If you contribute new python based testcases, we advise you to 105If you contribute new python based testcases, we advise you to
107not repeat our past misfortunes and write the tests in a standard 106not repeat our past misfortunes and write the tests in a standard
108test framework like for example pytest. 107test framework like for example pytest.
108
109For writing portable shell scripts, these tools are useful:
110@uref{https://github.com/koalaman/shellcheck, Shellcheck},
111@uref{https://salsa.debian.org/debian/devscripts/blob/master/scripts/checkbashisms.pl, checkbashisms},
112@uref{http://www.etalabs.net/sh_tricks.html},
113@uref{https://wiki.ubuntu.com/DashAsBinSh},
114and @uref{https://mywiki.wooledge.org/Bashism}
115
116@c You could also run "bin/check_shell_script" (which we still have
117@c to write).