Skip to content

Java-SDK: Markdown-Files + CI (war: MVP Java-SDK - Part 2)

Warum?

Ziel des MVP ist es, mit minimalem Aufwand eine erste veröffentlichungsfähige Version des SDKs zu entwickeln.

Out-of-Scope:

  • Erstellung des Grundgerüst für Methodensignaturen -> #414 (closed)
  • Aufgaben aus #15 (closed)
  • Bisherige Aufgabe aus Part 2 wurden in einzelne Issues aufgeteilt.

Relevante Links und Bemerkungen

  • SDK-Konzept im Wiki
  • inoffizielles Python-SDK
  • Die kommunale Dienstleister Komm.One in BaWü hätte Interesse am JAVA SDK und würde auch aktiv mit programmieren wollen. Kontakt kann über die FITKO hergestellt werden.
  • Gedanken zu Dependency-Verwaltung

Akzeptanzkriterien

  1. Es gibt eine CHANGELOG.MD gemäß https://keepachangelog.com/de/1.0.0/
  2. Die Readme.md enthält alle nötigen Infos zum Einstieg in das SDK.
  3. Das SDK kann auch bereits verschlüsselte Metadaten/Fachdaten/Anlagen entgegennehmen (aus Javascript-SDK). -> #579 (closed)
  4. Die Funktionalität des SDK wurde durch einen E2E-Test überprüft (via CI). Nötige Credentials werden als masked CI-Variablen hinterlegt.
  5. Im Peer Review wurden die Readme sowie weitere im Java-SDK-Repo enthaltene Dokumentation auf Verständlichkeit und Konsistenz überprüft.

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

Edited by Martin Vogel