Seminar openCode – Softwareveröffentlichung und publiccode.yml

Ein vorhandenes Repository wird erst durch aussagekräftige Metadaten für andere Verwaltungen gut auffindbar und verständlich. Das Seminar behandelt deshalb die redaktionelle und technische Vorbereitung des Eintrags im openCode-Softwareverzeichnis. Projektbeschreibung, Lizenz, Wartungsmodell und technische Angaben werden aufeinander abgestimmt. Die publiccode.yml wird aus überprüften Projektinformationen erstellt und mit dem verfügbaren openCode-Editor validiert, bevor sie in den freigegebenen Projektbestand übernommen wird.

An einem vorbereiteten Beispiel werden typische Fehler systematisch bearbeitet: ein unpassender Dateiname, fehlende Angaben, ungültige Kategorien oder falsche Bildpfade. Der Schritt vom Repository zum Verzeichniseintrag wird als eigener, zeitversetzter Verarbeitungsvorgang berücksichtigt. Deshalb werden sowohl der abgegebene Datenstand als auch ein bereits vorhandener Beispieleintrag überprüft. Das Seminar eignet sich für Teams, die eine Softwarefreigabe bereits geklärt haben und nun eine konsistente, pflegbare Veröffentlichung vorbereiten möchten.

Inhaltsübersicht

1. Veröffentlichungsstand vorbereiten
2. Metadaten fachlich strukturieren
3. publiccode.yml erstellen und validieren
4. Darstellung und Aktualisierung prüfen

1. Veröffentlichungsstand vorbereiten

• Voraussetzungen eines öffentlich zugänglichen Projekts auf openCode sowie den Zusammenhang zwischen Repository und Verzeichniseintrag prüfen.
• README, LICENSE, Installationshinweise und zuständige Ansprechpartner auf Konsistenz und praktische Verwendbarkeit untersuchen.
• Festgelegte Lizenz und geklärte Rechteposition übernehmen; offene Freigabefragen an die verantwortlichen Stellen zurückgeben.

Praxisübung: Eine vorbereitete Repository-Checkliste anwenden und fehlende Angaben vor der Metadatenbearbeitung identifizieren.

2. Metadaten fachlich strukturieren

• Name, Beschreibung, Entwicklungsstand, Softwaretyp, Kategorien, Wartung und unterstützte Einsatzbereiche nachvollziehbar beschreiben.
• Kurze und ausführliche Beschreibungen unterscheiden; technische Voraussetzungen und fachlichen Nutzen präzise formulieren.
• Sprachvarianten, Verantwortliche und Bildmaterial passend zum Projektbestand vorbereiten.

Praxisübung: Eine Rohbeschreibung in eine kurze und eine ausführliche Projektbeschreibung überführen und unbelegte Aussagen entfernen.

3. publiccode.yml erstellen und validieren

• Die vom openCode-Editor unterstützte Schemafassung verwenden; Pflichtangaben und optionale Angaben nach ihrem tatsächlichen Nutzen auswählen.
• YAML-Struktur, Einrückung und Datentypen prüfen; die Datei exakt als publiccode.yml im Repository-Hauptverzeichnis ablegen.
• Editorvalidierung, fachliche Gegenprüfung und GitLab-Review kombinieren; Schemafehler und inhaltliche Widersprüche getrennt behandeln.

Praxisübung: Die Metadatendatei erstellen, eingebaute Validierungsfehler beheben und die geprüfte Fassung über einen Änderungsvorschlag übernehmen.

4. Darstellung und Aktualisierung prüfen

• Logo- und Screenshotpfade, Sprachzuordnung sowie die Erreichbarkeit bereitgestellter Projektressourcen prüfen.
• Die zeitversetzte Übernahme ins Softwareverzeichnis berücksichtigen; den veröffentlichten Stand mit der abgegebenen Datei vergleichen.
• Änderungen an Version, Wartung, Ansprechpartnern und Beschreibung in einen wiederholbaren Pflegeprozess überführen.

Praxisübung: Einen vorhandenen Beispieleintrag mit seinem Repository abgleichen und einen kontrollierten Aktualisierungsvorgang einschließlich Nachprüfung vorbereiten.

Schulungsumgebung

Der Kunde stellt Browser, Editorzugang und ein freigegebenes Übungsrepository mit Schreibberechtigung bereit. Lizenzentscheidung, Beschreibungsdaten und zulässiges Bildmaterial liegen vor. Die tatsächliche öffentliche Bereitstellung erfolgt nur mit organisatorischer Freigabe; die Indexierung kann über das Seminar hinaus dauern.