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 ...

publiccode.yml
publiccodeYmlVersion: "0.4"   # Version des publiccode.yml-Formats
# Bitte publiccodeYmlVersion nur ändern, wenn sie wissen, was sie tun
name: "PROJEKT_NAME"    # Name ihres Projekts
url: "https://gitlab.opencode.de/IHR_PROJEKT"    # URL zu ihrem Projekt
# Die URL ist meist ihre Projektseite auf gitlab.opencode.de
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: .opencode/logo.svg     # Pfad zu ihrem Logo
# Der Pfad ihres Logo ist relativ von dem obersten Ordner ihres Projekts
# Erlaubte Dateiformate: .svg, .svgz, .png
platforms:    # Unterstützte Plattformen
  # Mögliche Einträge: web, windows, mac, linux, ios, android
  - linux
  - windows
  - mac
usedBy:    # Prominente Nutzung ihrer Software (beliebige Anzahl an Einträgen)
  - Zendis
categories:    # Kategorien, die am besten ihre Software beschreiben
  - financial-reporting
  - email-marketing
# Eine Liste der möglichen Kategorien finden sie auf folgender Webseite:
# https://yml.publiccode.tools/categories-list.html
developmentStatus: development    # Entwicklungsstatus ihrer Software
# Eine mögliche Angabe aus folgenden Werten:
# concept, development, beta, stable, obsolete
softwareType: "standalone/desktop"    # Der Typ ihrer Software
# Eine mögliche Angaben aus folgenden Werten:
# standalone/backend, standalone/desktop, standalone/iot,
# standalone/mobile, standalone/web, standalone/other,
# addon, library, configurationFiles

description:
  de:
    shortDescription: >    # Kurze Beschreibung (AUF DEUTSCH)
      Eine kurze Beschreibungen, welche
      mehrere Zeilen umfassen kann.
    longDescription: >    # Ausführliche Beschreibung (AUF DEUTSCH)
      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
      # Pfad zu ihren Screenshots
      # Die Pfade sind ausgehend von dem obersten Ordner ihres Projekts
      - .opencode/screenshots/sshot1.jpg
      - .opencode/screenshots/sshot2.jpg
      - .opencode/screenshots/sshot3.jpg
  en:
    shortDescription: >    # Kurze Beschreibung (AUF ENGLISCH)
      A rather short description that
      can span multiple lines.
    longDescription: >    # Ausführliche Beschreibung (AUF ENGLISCH)
      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
  # Eine Liste der zugelassenen Lizenzen finden sie auf folgender Webseite:
  # https://opencode.de/wissen/rahmenbedingungen/standardisierte-open-source-lizenzen
  # Gültig sind Einträge im Format der auf der Seite angegebenen SPDX-Identifier

maintenance:
  type: "community"    # Art der Betreuung der Software
  # Eine Angabe aus folgenden Werten: internal, contract, community, none
  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"

localisation:
  localisationReady: true
  availableLanguages:    # Unterstützte Sprachen ihrer Anwendung
  # Sprachen im Form eines IETF BCP 47 language tag
  # Siehe: https://en.wikipedia.org/wiki/IETF_language_tag
    - de
    - en

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/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

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: