OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Test single line usage in lists (#886) 

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
pull/889/head
Jerome Luckenbach 2019-01-30 21:09:19 +01:00 committed by Yannick Schaus
parent a426016b2c
commit 9c61239b5f
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
developers/development/bindings.md
View File

@ -25,8 +25,13 @@ _Note:_ Here you can find a [screencast of the binding skeleton creation](http:/
If you plan to contribute your binding to openHAB through a PR, here is what we suggest to help keeping the potential effort for changes due to reviews low:
- Before you start with the implementation, create an issue on GitHub and talk about your plan to come up with a PR. Maybe there are others that have privately a similar binding before and would be ready to contribute it. Also, it might help finding collaborators for the implementation.
- It is a good idea to start with modelling the Things for your binding, i.e. what kind of Bridge-Types, Thing-Types and Channel-Types it should have. Also, you should create the classes for the handlers that you need as well as potential discovery services (but no need to implement any working code at that stage). With this in place, you are invited to already create a PR and mark it as [WIP] (for: work in progress) and ask for a first review. You might get valuable input from maintainers and other experts and you avoid having to refactor all details of an implementation.
- Before you start with the implementation, create an issue on GitHub and talk about your plan to come up with a PR.
Maybe there are others that have privately a similar binding before and would be ready to contribute it.
Also, it might help finding collaborators for the implementation.
- It is a good idea to start with modelling the Things for your binding, i.e. what kind of Bridge-Types, Thing-Types and Channel-Types it should have.
Also, you should create the classes for the handlers that you need as well as potential discovery services (but no need to implement any working code at that stage).
With this in place, you are invited to already create a PR and mark it as [WIP] (for: work in progress) and ask for a first review.
You might get valuable input from maintainers and other experts and you avoid having to refactor all details of an implementation.
- Once the general architecture/modelling of your binding is approved, go for the implementation details and ask for a final review in the end.
## Implement the Binding

2
developers/index.md
View File

@ -8,7 +8,7 @@ title: Developer Guide
The _Developer Guide_ contains practical and technical information for people that want to get into the development of openHAB.
- Get an overview of how the openHAB project work is [organised](contributing/governance).
- Get an overview of how the openHAB project work is [organised](contributing/governance.html).
- Learn [how to contribute](contributing/contributing.html) to the project.
- Review the [coding guidelines](development/guidelines.html) and [conventions](development/conventions.html).
- See the details of how to [setup an IDE](development/ide.html) for development.