Erstellung einer publiccode.yml

Die Datei publiccode.yml ist ein Standardformat für Metadaten, mit dem Open-Source-Projekte im öffentlichen Sektor beschrieben werden können.

Auf openCode werden alle Einträge im softwareverzeichnis automatisch aus den jeweiligen publiccode.yml-Dateien der Projekte auf der GitLab-Instanz übernommen. Das bedeutet umgekehrt, dass nur Projekte im Verzeichnis erscheinen, die eine gültige publiccode.yml-Datei enthalten.

Diese Anleitung soll Sie nun dabei unterstützen, eine solche publiccode.yml für Ihre Software zu erstellen.

Wie erstelle ich eine funktionierende publiccode-yml-Datei?

  1. Öffnen Sie Ihr Projekt auf GitLab

  2. Navigieren Sie zu Repository > Dateien

  3. Erstellen Sie eine neue Datei mit dem Namen publiccode.yml. Laden Sie sich dazu diese kommentierte ausführliche Vorlage herunter oder die minimale Vorlage (Diese enthält die minimal nötigen Schlüssel für eine funktionierende publiccode.yml. Sie müssen dann nur noch den Namen zu publiccode.yml ändern.). Sie können zur Erstellung der Datei auch den openCode-Editor nutzen.

  4. Pflegen Sie die Grunddaten: Beginnen Sie mit dem offiziellen Schema wie Name, Version Ihrer Software, die URL und passende Kategorien. Auf der Seite des Metadatenstandards finden Sie eine Liste der möglichen Einträge.

  5. Füllen Sie die Projektbeschreibung aus: Erklären Sie kurz und klar, was Ihr Softwareprojekt ist und bebildern Sie es mit aussagekräftigen Screenshots. Unsere Empfehlung: Zwei Sprachen pflegen!

  6. Bestimme Sie die Zielgruppe (Länder und Themengebiete) der Software:

  7. Lizenz und Ansprechpersonen hinzufügen: Geben Sie an, unter welcher Lizenz Ihr Projekt steht und wo der Code liegt. Die ausgewählte Lizenz muss auf unserer Liste mit erlaubten Lizenzen stehen. Außerdem benennen Sie hier einen Kontakt, der die Software betreut.

  1. Prüfen und veröffentlichen: Am Einfachsten überprüfen Sie Ihre publiccode.yml-Datei, indem Sie diese in unseren openCode-Editor laden und danach auf die Validate-Schaltfläche klicken. Sollte die Datei fehlerfrei sein, steht der Veröffentlichung nichts mehr im Wege. Nach dem Erstellen der Datei wird Ihr Projekt kurze Zeit später automatisch im softwareverzeichnis sichtbar.

Anpassen der Darstellung im openCode softwareverzeichnis

Um die Darstellung Ihrer Software im softwareverzeichnis am Besten an Ihre Wünsche anzupassen, empfehlen wir Ihnen der weiterführenden Anleitung zur Anpassung der Darstellung im softwareverzeichnis in diesem Guide zu folgen.

Best-Practices aus der Community

Folgende Beispiele aus der Community können für Sie nützlich sein, um die Erstellung einer publiccode.yml-Datei nachvollziehen zu können:

Häufig gestellte Fragen und Probleme

Wieso werden Logo oder Screenshots meines Projektes nicht angezeigt?

Falls das Logo oder die Screenshots Ihres Projektes nicht angezeigt werden, kann das an folgenden Fehlern liegen:

  • In der publiccode.yml-Datei ist Ihr Logo oder Ihre Screenshots noch nicht aufgeführt. Fügen Sie die Datei hinzu und ergänzen Sie den Pfadnamen. Die Logo-Datei muss sich in dem obersten Ordner Ihres Projekts befinden.
  • Screenshots fügen Sie im Bereich description unter dem Bereich der jeweiligen unterstützen Sprache (z.B. de) ein.
  • Ggf. nutzen Sie ein nicht unterstütztes Dateiformat. Gültige Dateiformate für Logos sind: .svg, .svgz und .png. Gültige Dateiformate für Screenshots sind: .png und .jpg.
  • Der von Ihnen angegebene Pfad zu Ihrer Logo-Datei ist nicht korrekt. Überprüfen Sie den Pfad.
Wie finde ich Fehler in meiner publiccode.yml-Datei?

Am besten nutzen Sie unseren publiccode.yml-Editor, um Ihre publiccode.yml-Datei zu erstellen.

Im Editor können Sie entweder nach dem Hochladen Ihrer publiccode.yml-Datei oder nach dem Ausfüllen der entsprechenden Felder über die Schaltfläche Validate Fehler in Ihrer Datei anzeigen lassen.