Skip to content

Commit d290979

Browse files
committed
quick writeup what to ask contributors to watch out for; a moredditions welcome
Signed-off-by: Markus Storm <markus.storm@gmx.net>
1 parent 1e4e300 commit d290979

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ Get in contact early in the development to propose your idea.
1818
Fork the repo and make changes on your fork in a feature branch.
1919
Then be sure to also provide or update the documentation right when creating or modifying features.
2020

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+
2131
### Code architecture
2232
Always write clean, modular and testable code.
2333
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

Comments
 (0)