Erstellung einer publiccode.yaml-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 Wurzelverzeichnis ihres Projekts auf gitlab.opencode.de befinden. Es werden alle Repositories täglich auf neue publiccode.yml-Dateien geprüft. Ihr Software sollte also am nächsten Tag in unser Softwareverzeichis aufgenommen worden sein.

Sie können zum Erstellen dieser Datei entweder:

• unseren Generator nutzen, welcher auf Nutzer:innenfreundlicher Art und Weise hilft eine standard-konforme Datei zu generieren: https://editor.opencode.de/
• Oder Sie orientieren sich an folgender kommentierter publiccode.yml-Datei:

publiccodeYmlVersion: "0.4"

name: "PROJEKT_NAME" # Name ihres Projekts
url: "https://gitlab.opencode.de/IHR_PROJEKT" # URL zu ihrem Code auf gitlab.opencode.de
landingURL: "https://gitlab.opencode.de" # URL zu der Webseite ihrer Software
softwareVersion: "1.0.1" # Version ihrer Software
releaseDate: "2022-01-24" # Veröffentlichungsdatum ihrer Software
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:
  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.

    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 Feature
    screenshots: # Screenshots zu ihrem Projekt
    # Relativer Dateilink (ausgehend von ihrem Repository)
      - img/sshot1.jpg
      - img/sshot2.jpg
      - img/sshot3.jpg

legal:
  license: AGPL-3.0-or-later # Die Open-Source-Lizenz ihrer Software
  # Eine Liste der auf openCode zugelassenen Lizenzen finden sie auf folgender Seite:
  # https://wikijs.opencode.de/de/Hilfestellungen_und_Richtlinien/Lizenzcompliance#h-2-open-source-lizenzliste
  # 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 (beliebig vielen) 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
    - de
    - en

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

Beispiele aus der Community

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

• publiccode.yml der Smart Village App
• publiccode.yml des Content-Management-Systems Government Site Builder
• publiccode.yml des Grüne-Welle-Assistent Leezenflow der Stadt Münster
• publiccode.yml der Portalsoftware für regionales Kulturmarketing (CMS) OpenCulturas

---

Last update: January 15, 2025
Created: January 15, 2025