Skip to content

Contributions workflow

Tom-Bom-badil edited this page Oct 11, 2026 · 3 revisions

At first - thanks for supporting this project, much appreciated! To keep things clean and avoid chaos, please follow this simple branch workflow if you want to help developing the integration further.

Branch structure


    %%{init: {"themeCSS": ".nodeLabel, .nodeLabel p, .edgeLabel, .edgeLabel p { font-size: 10px !important; line-height: 1.2 !important; background-color: transparent !important; } .labelBkg { background-color: transparent !important; } .edgeLabel rect { fill: transparent !important; opacity: 0 !important; } "}}%%

    flowchart TB

    main["<b>:main branch</b>
    Holds current release
    Locked - *NO* PR's!"]

    develop["<b>:develop branch</b>
    central mergepoint,
    development + beta code
    Fork from here!"]

    main ~~~ develop
    develop -.->|New release only:<br/>Fast Forward merging.| main

    develop_tom[":develop_tom
    working branch

    my changes go here"]

    develop_you["<b>:develop_you</b>
    your working branch
    (made from :develop)
    → your changes here ←"]

    develop_someone[":develop_someone
    working branch

    their changes go here"]

    develop_sometwo[":develop_sometwo
    working branch

    their changes go here"]

    develop <-.->|My changes| develop_tom
    develop <-.->|Your PR's| develop_you
    develop <-.->|Their PR's| develop_someone
    develop <-.->|Their PR's| develop_sometwo

    style main stroke:red,color:red
    style develop stroke:green,color:green
    style develop_you stroke:green,color:green
Loading

Contributions: Getting ready, step-by-step

  • Fork this repository first
    Please fork the repository and do your work in your own copy.

  • Create your own working branch
    Create your branch based on develop (select develop branch, then create your own working branch from it).

    git checkout develop
    git pull
    git checkout -b develop_yourname
    
  • Start coding 🙂 (you can find a lot of development-related information here)

Some simple guidelines

  • Keep your branch up to date
    Before opening or updating a PR, please sync your branch with the latest develop.

  • Keep your branch focused
    One topic per pull request is much easier to review than one huge mixed change.

  • Keep responsibilities in the correct repository

    • Changes to Home Assistant's config flow, devices, entities, translations, coordinator behavior, or presentation belong in this repository,
    • Changes to controller addresses, scaling, ranges, enum options, hydronic roles, sensor resolution, validation, or write rules have to go into trovis-modbus instead.
  • Before opening a pull request: Run some basic checks
    Please run the following scripts to perform the basic formatting and repository checks.

    script/format.sh
    script/hasscheck.sh
    
  • Always create your pull request against develop
    All new features, fixes and experiments must go into develop first. The main branch is configured to auto-reject direct PR's, as it's main task is to hold the code of the current release.

  • A short description helps a lot
    Please briefly describe what you changed, why you changed it, and whether you already tested it.

  • Keep your pull requests editable
    When opening the PR, keep Allow edits by maintainers enabled. This makes it much easier to help with small fixes, cleanup, merge conflicts, or targeting the right branch.

**❤️ Once more: Thank you for contributing, much appreciated!!! :) ❤️**

german Wiki - Start english


english Bauanleitungen

Schritt 1 - Kabel

Schritt 2 - Adapter

Schritt 3 - Schnittstelle

Schritt 4 - Regler

Schritt 5 - Erster Test

🔥 Update: Weitere Adapter


english Home Assistant Integration

🚀 Getting started

🔌 Using the integration

🧑‍💻 Technical reference

🔢 Related projects


english SmartHomeNG Plugin


german2 Anhang: Info-Sammlung

Clone this wiki locally