Aufnahme in das Softwareverzeichnis
Das Softwareverzeichnis: Finden und erstellen Sie Open-Source-Softwareprojekte Kopiert!
In unserem Softwareverzeichnis finden Sie einen durchsuchbaren Katalog an Open-Source-Projekten und Lösungen. Jeder Eintrag erhält die wichtigsten Details zu Kontaktdaten, Lizenzen, Badges, Qualitätsmerkmalen und vielem mehr – offen und transparent für alle.
Unser Ziel: Auf einen Blick darstellen, ob die Software für Sie geeignet ist, wie Sie sie rechtssicher nutzen oder weiterentwickeln können.
Das Softwareverzeichnis soll aber auch Anreize liefern, selbst Code zu teilen. Diese Hilfestellung soll Ihnen daher dabei helfen, Projekte und Lösungen richtig ins Verzeichnis einzustellen und abzubilden.
Aufnahme ins Softwareverzeichnis Kopiert!
Projekte erstellen und verwalten Kopiert!
Hier erfahren Sie, wie Sie ein neues Projekt auf https://gitlab.opencode.de/ anlegen können. Ihre Softwareprojekte können im Softwareverzeichnis über individuelle Detailseiten dargestellt werden, damit sie leichter gefunden werden und auch genutzt werden können.
Dies passiert automatisiert durch eine sogenannte publiccode.yml-Datei. Sie beinhaltet alle Metadaten Ihres Projekts und ist notwendig, damit Projekte in unser Softwareverzeichnis aufgenommen werden.
Was ist die publiccode.yml? Kopiert!
Die publiccode.yml ist eine standardisierte Metadatei, mit der Sie Open-Source-Projekte für den öffentlichen Sektor beschreiben. Die Datei muss sich dabei im obersten OrdnerIhres Repositories auf https://gitlab.opencode.de/ befinden und genau diesen Dateinamen tragen. Pro Repository ist nur eine solche Datei möglich. Die notwendigen Schlüsselworte und Anforderungen an die publiccode.yml entspringen dem Metadaten Standard für Software von Öffentlichen Verwaltungen.
Wie erstelle ich eine funktionierende publiccode-yml-Datei? Kopiert!
Datei anlegen: Legen Sie im Root-Verzeichnis Ihres Projekts die Datei publiccode.yml an. Nutzen Sie dafür den openCode-Editor oder die kommentierte Vorlage.
Grunddaten pflegen: Beginnen Sie mit dem offiziellen Schema wie Name, URL und Kategorien. Hier finden Sie eine Liste der möglichen Kategorien.
Projektbeschreibung ausfüllen: Erklären Sie kurz und klar, was Ihr Softwareprojekt ist und bebildern Sie es mit aussagekräftigen Screenshots. Unsere Empfehlung: Zwei Sprachen pflegen!
Softwaredetails eintragen: Geben Sie an, unter welcher Lizenz Ihr Projekt steht und wo der Code liegt. Eine Liste der zugelassenen Lizenzen finden Sie hier. Außerdem benennen Sie hier einen Kontakt, der die Software betreut.
Prüfen und veröffentlichen: 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. Sollte die Datei fehlerfrei sein, steht der Veröffentlichung nichts mehr im Wege. Nach dem Erstellen der Datei wird Ihr Projekt zeitversetzt im Softwareverzeichnis sichtbar.
Diese Abbildung zeigt die Ansicht der ausgegebenen Werte an einem Beispielprojekt.
