Modulentwicklung und wie?

Hi zusammen,

wollte gerade mal meine Module überarbeiten und auf den neusten Stand bringen. Dabei sind ein paar Fragen aufgetauscht die Ihr hier bestimmt beantworten könnt:

1.) Dokumentation

Es gibt ja jetzt das unterstützte Verzeichnis „docs“ wo man alles Beschreibende reinpacken kann. Wenn man mehrere Module in einer Bibliothek hat, dann hatte ich es bisher so - das pro Modulverzeichnis eine readme.md lag und oben im Bibo-Verzeichnis auch eine mit allgemeinen Aufzählungen.

Wie strukturiert man das jetzt mit dem docs Verzeichnis? Gibt man den readme’s jetzt andere Namen oder wie ist da der Best Practice?
Legt man die Bilder für die Doku mit in den Ordner oder parallel ins „imgs“ Verzeichnis?

2.) Branches

Wenn man möchte das bisherige Module weiter für ältere Versionen nutzbar seinen sollen, aber auch neue Möglichkeiten der 5.x verwenden will muss man ja mehrere Banches zur Verfügung stellen.
Wenn ich die Diskussionen richtig verfolgt habe ist der allgemeine Standard das immer die aktuellste Version in „master“ liegt und die ältere Version ala „IPS4“ oder so bereitgestellt wird. Ist das der allgemeine Konsens oder wie macht man es richtig?

Danke & Ciao
Heiko

  1. Ich würde es pro README im Ordner belassen. docs nutze ich z.B. für Bilder, welche zusätzlich benötigt werden.
  2. Ja, so würde ich es machen.

paresy

Danke paresy, dann leg ich mal los :wink: