Fix markdown repo files (#19033)

Signed-off-by: Leo Siepel <leosiepel@gmail.com>
This commit is contained in:
lsiepel
2025-07-26 12:13:39 +02:00
committed by GitHub
parent 6304dbc7b6
commit 901927d0a2
3 changed files with 25 additions and 26 deletions
+14 -13
View File
@@ -24,7 +24,7 @@ received feedback on what to improve.
We're trying very hard to keep openHAB lean and focused. We don't want it
to do everything for everybody. This means that we might decide against
incorporating a new feature. However, there might be a way to implement
that feature *on top of* openHAB.
that feature _on top of_ openHAB.
### Discuss your design in the discussion forum
@@ -60,7 +60,7 @@ your documentation changes for clarity, concision, and correctness, as
well as a clean documentation build.
Write clean code. Universally formatted code promotes ease of writing, reading,
and maintenance.
and maintenance.
Pull requests descriptions should be as clear as possible and include a
reference to all the issues that they address.
@@ -88,7 +88,7 @@ pass it on as an open-source patch. The rules are pretty simple: if you
can certify the below (from
[developercertificate.org](https://developercertificate.org/)):
```
```text
Developer Certificate of Origin
Version 1.1
@@ -129,20 +129,22 @@ By making a contribution to this project, I certify that:
then you just add a line to every git commit message:
Signed-off-by: Joe Smith <joe.smith@email.com>
```text
Signed-off-by: Joe Smith <joe.smith@email.com>
```
using your real name (sorry, no pseudonyms or anonymous contributions.) and an
e-mail address under which you can be reached (sorry, no github noreply e-mail
addresses (such as username@users.noreply.github.com) or other non-reachable
addresses (such as `username@users.noreply.github.com`) or other non-reachable
addresses are allowed).
On the command line you can use `git commit -s` to sign off the commit.
### How can I become a maintainer?
* Step 1: learn the component inside out
* Step 2: make yourself useful by contributing code, bugfixes, support etc.
* Step 3: volunteer on [the discussion group](https://github.com/openhab/openhab-addons/issues?labels=question&page=1&state=open)
- Step 1: learn the component inside out
- Step 2: make yourself useful by contributing code, bugfixes, support etc.
- Step 3: volunteer on [the discussion group](https://github.com/openhab/openhab-addons/issues?labels=question&page=1&state=open)
Don't forget: being a maintainer is a time investment. Make sure you will have time to make yourself available.
You don't have to be a maintainer to make a difference on the project!
@@ -153,22 +155,21 @@ We want to keep the openHAB community awesome, growing and collaborative. We
need your help to keep it that way. To help with this we have come up with some
general guidelines for the community as a whole:
* Be nice: Be courteous, respectful and polite to fellow community members: no
- Be nice: Be courteous, respectful and polite to fellow community members: no
regional, racial, gender, or other abuse will be tolerated. We like nice people
way better than mean ones!
* Encourage diversity and participation: Make everyone in our community
- Encourage diversity and participation: Make everyone in our community
feel welcome, regardless of their background and the extent of their
contributions, and do everything possible to encourage participation in
our community.
* Keep it legal: Basically, don't get us in trouble. Share only content that
- Keep it legal: Basically, don't get us in trouble. Share only content that
you own, do not share private or sensitive information, and don't break the
law.
* Stay on topic: Make sure that you are posting to the correct channel
- Stay on topic: Make sure that you are posting to the correct channel
and avoid off-topic discussions. Remember when you update an issue or
respond to an email you are potentially sending to a large number of
people. Please consider this before you update. Also remember that
nobody likes spam.
+10 -11
View File
@@ -1,6 +1,6 @@
# openHAB Add-ons
<img align="right" width="220" src="./logo.png" />
<img align="right" width="220" src="logo.png" alt="openHAB logo" />
[![GitHub Actions Build Status](https://github.com/openhab/openhab-addons/actions/workflows/ci-build.yml/badge.svg?branch=main)](https://github.com/openhab/openhab-addons/actions/workflows/ci-build.yml)
[![Jenkins Build Status](https://ci.openhab.org/job/openHAB-Addons/badge/icon)](https://ci.openhab.org/job/openHAB-Addons/)
@@ -11,18 +11,18 @@ This repository contains the official set of add-ons that are implemented on top
Add-ons that got accepted in here will be maintained (e.g. adapted to new core APIs)
by the [openHAB Add-on maintainers](https://github.com/orgs/openhab/teams/add-ons-maintainers).
To get started with binding development, follow our guidelines and tutorials over at https://www.openhab.org/docs/developer.
To get started with binding development, follow our guidelines and tutorials over at <https://www.openhab.org/docs/developer>.
If you are interested in openHAB Core development, we invite you to come by on https://github.com/openhab/openhab-core.
If you are interested in openHAB Core development, we invite you to come by on <https://github.com/openhab/openhab-core>.
## Add-ons in other repositories
Some add-ons are not in this repository, but still part of the official [openHAB distribution](https://github.com/openhab/openhab-distro).
An incomplete list of other repositories follows below:
* https://github.com/openhab/org.openhab.binding.zwave
* https://github.com/openhab/org.openhab.binding.zigbee
* https://github.com/openhab/openhab-webui
- <https://github.com/openhab/org.openhab.binding.zwave>
- <https://github.com/openhab/org.openhab.binding.zigbee>
- <https://github.com/openhab/openhab-webui>
## Development / Repository Organization
@@ -33,7 +33,7 @@ The official IDE (Integrated development environment) is Eclipse.
You find the following repository structure:
```
```text
.
+-- bom Maven buildsystem: Bill of materials
| +-- openhab-addons Lists all extensions for other repos to reference them
@@ -127,7 +127,6 @@ In that case use:
mvn org.openhab.core.tools:i18n-maven-plugin:3.4.0:generate-default-translations
```
#### Code Quality
To check if your code is following the [code style](https://www.openhab.org/docs/developer/guidelines.html#b-code-formatting-rules-style) run:
@@ -136,7 +135,7 @@ To check if your code is following the [code style](https://www.openhab.org/docs
mvn spotless:check
```
To reformat your code so it conforms to the code style you can run:
To reformat your code so it conforms to the code style you can run:
```shell
mvn spotless:apply
@@ -145,7 +144,7 @@ mvn spotless:apply
### Integration Tests
When your add-on also has an integration test in the `itests` directory, you may need to update the runbundles in the `itest.bndrun` file when the Maven dependencies change.
Maven can resolve the integration test dependencies automatically by executing:
Maven can resolve the integration test dependencies automatically by executing:
```shell
mvn clean install -DwithResolver -DskipChecks
@@ -157,6 +156,6 @@ The build generates a `.jar` file per bundle in the respective bundle `/target`
We have assembled some step-by-step guides for different IDEs on our developer documentation website:
https://www.openhab.org/docs/developer/#setup-the-development-environment
<https://www.openhab.org/docs/developer/#setup-the-development-environment>
Happy coding!
+1 -2
View File
@@ -1,7 +1,6 @@
## Karaf features
# Karaf features
In this directory you find Karaf features defined.
Karaf features allow to define dependencies for openHAB add-ons and OSGi bundles in general.
If you require an external library in your openHAB add-on, you most likely want to edit the Karaf features file as well.