Skip to content

Aufnahme in das Softwareverzeichnis

Erstellung einer publiccode.yml-Datei

Auf dieser Seite finden Sie eine Anleitung zur Erstellung einer publiccode.yml-Datei.

Eine publiccode.yml-Datei ist notwendig, damit Projekte in unser Software-Verzeichnis aufgenommen werden. Die publiccode.yml-Datei muss sich dabei im obersten Ordner ihres Projekts auf gitlab.opencode.de befinden. Es werden alle Repositories auf neue publiccode.yml-Dateien geprüft und danach in das openCode-Softwareverzeichnis aufgenommen.

Infografik zur Veröffentlichung eines Projekts im openCode-Softwareverzeichnis

Sie können zum Erstellen einer publiccode.yml-Datei ...

  • entweder unseren Generator nutzen, welcher auf Nutzer:innenfreundlicher Art und Weise hilft eine standard-konforme Datei zu generieren

    • Zum publiccode.yml-Editor

      Info

      Der Editor kann sie auf Fehler in Ihrer publiccode.yml Datei hinweisen. Drücken sie hierzu einfach, nachdem Sie ihre publiccode.yml-Datei hochgeladen haben, auf die "Validate"-Schaltfläche.

  • oder Sie orientieren sich an folgender kommentierter publiccode.yml-Datei:

publiccode.yml
publiccodeYmlVersion: "0.4"   # Version des publiccode.yml-Formats (1)
name: "PROJEKT_NAME"    # Name ihres Projekts
genericName: "Web Browser" # Funktionale Benennung ihre Projekts (2)
url: "https://gitlab.opencode.de/IHR_PROJEKT"    # URL zu Ihrem Projekt (3)
landingURL: "https://IHR-PROJEKT.de"    # URL zu der Webseite ihrer Software
softwareVersion: "1.0.1"     # Version ihrer Software
releaseDate: "2022-01-24"    # Veröffentlichungsdatum ihrer Software
logo: logo.svg     # Pfad zu ihrem Logo im Wurzelverzeichnis (4)
platforms:    # Unterstützte Plattformen (5)
  - linux
  - windows
  - mac
usedBy:    # Prominente Nutzung Ihrer Software (6)
  - Zendis
categories:    # Kategorien, die Ihre Software beschreiben (7)
  - financial-reporting
  - email-marketing
developmentStatus: development    # Entwicklungsstatus ihrer Software (8)
softwareType: "standalone/desktop"    # Der Typ ihrer Software (9)

localisation:
  localisationReady: true
  availableLanguages:    # Unterstützte Sprachen (10)
    - de
    - en

description:
  de:
    shortDescription: >    # Kurze Beschreibung AUF DEUTSCH (11)
      Eine kurze Beschreibungen, welche
      mehrere Zeilen umfassen kann.
    longDescription: >    # Ausführliche Beschreibung AUF DEUTSCH (12)
      Eine sehr lange Beschreibung dieser Software,
      auch auf mehrere Zeilen aufgeteilt.
      Sie sollten beschreiben, worum es bei der Software geht
      und warum man sie benötigt.
      Hier könnten potenziell viele Seiten Text enthalten sein.
    features:    # Auflistung der Features ihrer Software
      - Das erste Feature 
      - Ein anderes zweites Feature
    screenshots:    # Screenshots zu ihrem Projekt (13)
      - .opencode/screenshots/sshot1.jpg
      - .opencode/screenshots/sshot2.jpg
      - .opencode/screenshots/sshot3.jpg
  en:
    shortDescription: >    # Kurze Beschreibung AUF ENGLISCH (14)
      A rather short description that
      can span multiple lines.
    longDescription: >    # Ausführliche Beschreibung AUF ENGLISCH (15)
      Very long description of this software, also split
      on multiple rows. You should note what the software
      is and why one should need it. We can potentially
      have many pages of text here.

legal:
  license: AGPL-3.0-or-later    # Die Open-Source-Lizenz ihrer Software (16)

maintenance:
  type: "community"    # Art der Betreuung der Software (17)
  contacts:    # Auflistung von Kontakten, welche ihre Software betreuen
    - name: "Francesco Rossi"
      email: "francesco.rossi@zendis.de"
  contractors:    # Vertragspartner:innen
    - name: ZenDis
      email: "hallo@zendis.de"
      website: "zendis.de"
      until: "2023-01-01"
  1. Version des publiccode.yml-Standards. Nur ändern, wenn sie wissen, was sie tun!
  2. Dieser Schlüssel ist der "genericName", der sich auf die spezifische Kategorie bezieht, zu der die Software gehört. Sie können den generischen Namen normalerweise in einer Präsentation der Software finden, wenn Sie etwas wie folgt schreiben: "Software xxx ist ein yyy" Nennenswerte Beispiele sind zum Beispiel: "Texteditor", "Textverarbeitung", "Webbrowser", "Chat" und so weiter... Der generische Name darf bis zu 35 Zeichen lang sein.
  3. Die URL ist meist ihre Projektseite auf gitlab.opencode.de
  4. Der Pfad ihres Logo ist relativ von dem obersten Ordner ihres Projekts. Erlaubte Dateiformate sind: .svg, .svgz und .png
  5. Mögliche Einträge: web, windows, mac, linux, ios, android
  6. Beliebige Anzahl an Einträgen möglich.
  7. Eine Liste der möglichen Kategorien finden sie auf folgender Webseite: https://yml.publiccode.tools/categories-list.html
  8. Einer der folgenden Angaben: concept, development, beta, stable, obsolete
  9. Eine der folgenden Angaben: standalone/backend, standalone/desktop, standalone/iot, standalone/mobile, standalone/web, standalone/other, addon, library, configurationFiles
  10. Sprachen im Form eines IETF BCP 47 language tag (siehe https://en.wikipedia.org/wiki/IETF_language_tag)
  11. Maximal 150 Zeichen (in Deutsch)
  12. Dieser Schlüssel enthält eine längere Beschreibung der Software, zwischen 500 und 10000 Zeichen (auf Deutsch). Sie soll einem potenziellen Benutzer einen Überblick über die Fähigkeiten der Software für einen potenziellen Benutzer geben. Die Zielgruppe für diesen Text sollten die Benutzer der Software sein, nicht die Entwickler. Sie können sich diesen Text vorstellen Text als die Beschreibung der Software, die auf ihrer Website zu finden wäre (wenn sie eine hätte). Diese Beschreibung kann einige grundlegende Markdown-Elemente enthalten: *Kursiv*, **fett**, - Aufzählungen und [Links](#).
  13. Pfad zu ihren Screenshots. Die Pfade sind ausgehend von dem obersten Ordner ihres Projekts
  14. Maximal 150 Zeichen (in Englisch)
  15. Dieser Schlüssel enthält eine längere Beschreibung der Software, zwischen 500 und 10000 Zeichen (auf Englisch). Sie soll einem potenziellen Benutzer einen Überblick über die Fähigkeiten der Software für einen potenziellen Benutzer geben. Die Zielgruppe für diesen Text sollten die Benutzer der Software sein, nicht die Entwickler. Sie können sich diesen Text vorstellen Text als die Beschreibung der Software, die auf ihrer Website zu finden wäre (wenn sie eine hätte). Diese Beschreibung kann einige grundlegende Markdown-Elemente enthalten: *Kursiv*, **fett**, - Aufzählungen und [Links](#).
  16. Eine Liste der zugelassenen Lizenzen finden sie auf folgender Webseite: https://opencode.de/wissen/rechtssichere-nutzung/open-source-lizenzen#2.-Open-Source-Lizenzliste (gültig sind Einträge im Format der auf der Seite angegebenen SPDX-Identifier).
  17. Eine der folgenden Angaben: internal, contract, community, none

Die Spezifikationen für den publiccode Standard können Sie folgender Webseite entnehmen: https://yml.publiccode.tools/schema.core.html

Empfohlene Order-Struktur ihres Projekts

Wir empfehlen eine Ordner-Struktur, die ähnlich wie folgt aussieht:

Mein-Projekt/
├── logo.svg
└── .opencode/
    └── screenshots/
        ├── sshot1.png
        ├── sshot2.png
        └── sshot3.png

Häufige Probleme

Das Logo oder die Screenshots meines Projekts werden nicht angezeigt?

Falls das Logo oder sind die Screenshots ihres Projekts nicht angezeigt werden, kann das daran an folgenden Fehlern liegen:

  • In der publiccode.yml-Datei ist ihr Logo oder ihre Screenshots noch nicht aufgeführt:

    • Hinzufügen eines Logos: Fügen sie einen ähnlichen Eintrag, wie den folgenden, zu ihrer publiccode.yml-Datei hinzu (logo.svg entspricht dabei dem Dateinamen ihres Logos):

      logo: logo.svg

      Warnung

      Die Logo-Datei muss sich in dem obersten Ordner ihres Projekts befinden.

    • Hinzufügen von Screenshots: Fügen sie im Bereich description unter dem Bereich der jeweiligen unterstützen Sprache (z.B. de) einen ähnlichen Eintrag, wie den folgenden, hinzu:

      description:
    de:
      screenshots:
        - .opencode/screenshots/sshot1.jpg
        - .opencode/screenshots/sshot2.jpg
        - .opencode/screenshots/sshot3.jpg

  • Sie nutzen ein von uns 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, ob der Ordner (ausgehend vom obersten Ordner ihres Projekts) existiert.
    • Schauen sie, ob sie die von uns empfohlene Ordner-Struktur verwenden: Empfohlene Ordner-Struktur

Ihr Projekt wird nicht in dem openCode Softwareverzeichnis angezeigt?

Dies liegt vermutlich daran, dass Sie entweder Fehler in Ihrer publiccode.yml-Datei haben, oder bestimme Einträge in Ihrer publiccode.yml-Datei vergessen haben.

Am Einfachsten überprüfen Sie Ihre publiccode.yml-Datei damit, wenn Sie diese in unseren publiccode.yml-Editor laden und danach auf die "Validate"-Schaltfläche klicken.

publiccode.yml-Dateien 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: