You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,16 @@ Get in contact early in the development to propose your idea.
18
18
Fork the repo and make changes on your fork in a feature branch.
19
19
Then be sure to also provide or update the documentation right when creating or modifying features.
20
20
21
+
* if adding a new function, see which of the functions/*.bash files it fits in best
22
+
* create install_xxx() routine and make it work with arguments "install" and "remove"
23
+
* Make sure install_xxx() works in interactive as well as non-interactive (unattended) mode
24
+
If user input is required, create another parameter in openhabian.conf (source for that is in build-image/)
25
+
To test:
26
+
source functions/helpers.bash; source functions/packages.bash; set -x
27
+
install_xxx arg1 arg2 ... argn
28
+
* add BATS tests for "install" and "remove"
29
+
30
+
21
31
### Code architecture
22
32
Always write clean, modular and testable code.
23
33
We have a simple [code-style](#codestyle) which in combination with the static linter [ShellCheck](https://www.shellcheck.net/) works as our coding guidelines.
0 commit comments