Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Developer docs: Improve new binding tutorial #2415

Merged
merged 1 commit into from
Dec 1, 2024
Merged

Developer docs: Improve new binding tutorial #2415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions developers/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,19 @@ We have prepared some step-by-step guides for the following IDEs:

Not sure what to choose?: openHAB maintainers use [Eclipse IDE](https://wiki.eclipse.org/Eclipse_Installer).

## Make your own copy of the code base

openHAB has [several repositories](https://github.com/openhab) on GitHub.
The most important ones are listed in the [Contribution section of the Developer Appendix](contributing.html#the-repositories).

For developing a new binding, you'll need to fork the [openhab-addons](https://github.com/openhab/openhab-addons) repository (see [GitHub Docs: Fork a repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)) and then clone your fork to your development machine.
Next, create a new branch for your work on the new binding.

## Read the guidelines

Before starting your work, please have a look at the [Coding Guidelines](guidelines.html) and the overall [Contribution docs](contributing.html).
It is always better to know the guidelines before starting coding than having to change your code afterwards.

## Develop a NEW binding

To help start developing a new binding, a script is available to generate the basic skeleton for you.
Expand Down Expand Up @@ -145,3 +158,13 @@ following will tell git and spotless to use LF endings:
```text
* text eol=lf
```

Further documentation about binding development can be found in the [Bindings Developer Guide](bindings/index.html).

## Contribute your changes back to openHAB

When you are finished with your new binding (or in the process of development and need help), you need to create a pull request (PR) to the so-called upstream repository, in this case openhab-addons.
Have a look at [GitHub Docs: Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) if you need help.

Once you have created your PR, the maintainers will review your code and provide feedback.
Please be patient and be prepared to make changes to your code based on the feedback you receive.