Dokumentation

Die Ref­eren­z­im­ple­men­tierung von BO4E befind­et sich auf GitHub. Nutzen Sie gerne das GitHub-Repos­i­to­ry, um Anforderun­gen zu Erweiterun­gen oder Anpas­sun­gen einzure­ichen. Aus der Ref­eren­z­im­ple­men­tierung wird stets automa­tisiert eine Doku­men­ta­tion gener­iert, die genutzt wer­den kann, um die Objek­te, Kom­po­nen­ten und Enu­mer­a­tio­nen kennenzulernen.

BO4E Doku­men­ta­tion BO4E Ref­eren­z­im­ple­men­tierung BO4E Archiv

Änderungs- und Erweiterungswün­sche beim BO4E-Stan­dard einreichen

Der BO4E-Stan­dard basiert auf der offiziellen open source Python-Ref­eren­z­im­ple­men­tierung im GitHub-Repos­i­to­ry BO4E-python. Über dieses Repos­i­to­ry kön­nen Änderun­gen und Erweiterun­gen entwed­er als Tick­et (Issue) oder direk­te Quell­codeän­derung (Pull Request) ein­gere­icht werden.

1. Rufe das BO4E-Repos­i­to­ry auf

Besuche https://​github​.com/​b​o​4​e​/​B​O​4​E​-​p​ython und melde dich mit deinem GitHub-Kon­to an. Falls du noch keines hast, reg­istriere dich kostenlos.

2. Wäh­le den passenden Weg für deinen Änderungswunsch

a) Tick­et in Textform:

• Öffne ein neues Issue
  
• Beschreibe dein Anliegen so detail­liert wie möglich. Nutze dabei die im Tick­et gener­ierte Vorlage.

b) Quell­codeän­derung in der Ref­eren­z­im­ple­men­tierung (für tech­nisch ver­sierte Nutzer):

• Erstelle einen neuen Pull Request.
• Imple­men­tiere deine Änderung oder Erweiterung direkt im Quell­code des Repos­i­to­ries. Beachte dabei den Con­tribut­ing Guide.
• Stelle sich­er, dass dein Pull Request eine klare Beschrei­bung enthält, die den Zweck und die Änderun­gen erklärt.

3. Warte auf die Bear­beitung durch das BO4E-Gremium

• Dein Issue oder Pull Request wird vom BO4E-Gremi­um i.d.R. inner­halb von zwei Wochen geprüft.
• Bitte schaue regelmäßig nach, ob Rück­fra­gen gestellt wurden.

Tipps für eine erfol­gre­iche Einreichung

• Prüfe zunächst, ob deine Anforderung bere­its in einem anderen Issue oder Pull Request behan­delt wird. Falls du etwas Passendes find­est, kannst du es abon­nieren, um bei Änderun­gen benachrichtigt zu werden.
• Stelle sich­er, dass deine Änderun­gen gut doku­men­tiert und leicht nachvol­lziehbar sind.
• Pull Requests wer­den häu­fig schneller bear­beit­et und in den Stan­dard aufgenom­men als Issues.
• Wenn du unsich­er bist, ob dein Vorschlag sin­nvoll ist, starte mit einem Issue und disku­tiere die Idee mit der Community.
• Das BO4E-Gremi­um ste­ht auch per E‑Mail (gremium@​bo4e.​de) und in unserem Slack Work­space (Ein­ladung auf Anfrage) zur Verfügung.

Mit dein­er Unter­stützung trägst du dazu bei, den BO4E-Stan­dard kon­tinuier­lich zu verbessern. Vie­len Dank für dein Engagement!