Skip to content

[P3] Contributor Guide erstellen #25

Description

@stritti

Beschreibung

Es gibt keine Entwicklerdokumentation für externe Mitwirkende.
Das erschwert Contributions und bremst die Community-Bildung.

Inhalt

Repository-Struktur

  • Welches Repository wofür
  • Mono-/Multi-Repo-Entscheidung erklären

Development Setup

  • PlatformIO-Umgebung
  • ESP32 DevKit vs. NORVI AE01-R
  • Lokale Tests (Hardware-in-the-Loop? CI ohne Hardware?)

Coding Guidelines

  • C++ Style (wird Google Style verwendet?)
  • Commit-Message-Convention
  • Homie-Convention-Einhaltung

Branching & Releases

  • Git-Flow? GitHub Flow?
  • Release-Prozess (Semver?)
  • OTA-Update-Prozess

PR-Prozess

  • Vorlage
  • Review-Anforderungen
  • CI/CD (GitHub Actions)

Teststrategie

  • Unit-Tests? (PlatformIO test)
  • Wie wird ohne Hardware getestet?
  • Manuelle Testfälle

Akzeptanzkriterien

  • CONTRIBUTING.md im Repository (oder content/docs/contributing/)
  • Deckt alle oben genannten Punkte ab
  • EN (DE optional)

Keine Bilder nötig.

Referenz

Aus der Dokumentationsanalyse – P3

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood-first-issueGood for newcomersp3Lower priority documentation gap

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions