Beispiele aus der Community
Auf dieser Seite finden Sie einige Beispiele aus unserer Community zusammengestellt.
Diese Beispiele verweisen auf Projekte auf unserer GitLab Instanz und eignen sich so sehr gut zur Illustration einiger häufigen Einsatzszenarien.
Lizenzierung eines Projektes
Die Open Source Lizenzierung eines Projekts ist wichtig, um anderen Nutzer:innen den Einsatz und die Anpassung des Projekts rechtssicher zu ermöglichen. Eine Open Source Lizenzierung ist eine grundsätzliche Vorraussetzung für öffentliche Projekte auf openCode.
- Auf dieser Seite finden Sie eine Auswahl einer durch openCode freigegebenen Open Source Lizenz: openCode kompatible Software-Lizenzen.
Beispiele verschiedener Lizenzen
- Lizenzierung nach EUPL-1.2 mit LICENSE Datei und README Vermerk: Projekt KoliBri Lizenz, Projekt KoliBri README
- Lizenzierung nach EUPL-1.2 mit LICENSE Datei und README Vermerk: Projekt EGVP-Address Book Lizenz, Projekt EGVP-AddressBook README
- Lizenzierung nach AGPL-3.0-or-later mit LICENSE Datei: Projekt LibretranslateGUI Lizenz
- Lizenzierung nach Apache-2.0 mit LICENSE Datei: Projekt Konformitaetstest Lizenz
Software Bill of Materials (SBOM)
Das zur Verfügung stellen von Software Bill of Materials (SBOM) ist eine Anforderung der Nutzungsbedingungen, wenn Kompilate, Binaries oder ähnliches, wie Containter Images auf openCode verbreitet werden.
Ein SBOM stelle eine detaillierte Liste dar, die alle Bestandteile (wie bei einer Zutatenliste) einer Software beschreibt. Diese Bestandteile können Programme, Bibliotheken oder andere Softwaremodule sein, die in einem größeren Softwareprojekt verwendet werden.
An dieser Stelle finden sie einige Beispiele und Referenz-Implementierungen:
- Projekt SPDX Conformance Referenzprojekt - SBOM
- Projekt Collaboratives Online Board - Frontend - SBOM
- Projekt EVB-IT digital-SBOM
Dokumentation der Security-Praktiken
Die Dokumentation von Security Praktiken und deren Ergebnissen trägt entscheidend zur Transparenz bei. Weiterhin ermöglicht diese anderen Nutzer:innen einen ersten Ansatzpunkt in der Einsatzentscheidung ihrer Software.
- Hinweis und Kontaktadresse zur nicht-öffentlichen Meldung von Sicherheitslücken: Projekt KoliBri SECURITY.md
- Kommunikation von Security Scan Ergebnissen für CVE Funde: Projekt Nextcloud Scan Ergebnisse
Synchronisierung aus anderen Repositories
Das Spiegeln (forken) von Repository-Inhalten von anderen Code-Versionierungssystemen auf openCode, kann durch vielfältige Mechanismen erfolgen, wenn im anderen Code-Versionierungssystemen aktiv weiterentwickelt werden soll. Dieser Fall ist von einer Portierung und aktiven Weiterentwicklung auf openCode zu unterscheiden.
- Ein-Wege Synchronisation von GitHub nach openCode via GitHub Actions mit festem Schedule: Projekt KoliBri
- Ein-Wege-Synchronisation von GitHub nach openCode (via openCode GitLab CI/CD) mit optionalem Schedule: Projekt Repository-Mirroring-Practices
Dokumentation eines Projekts
Die umfangreiche Dokumentation eines Projekts in einer README-Datei ist keine Grundvorraussetzung für die Veröffentlichung von Projekten auf openCode, jedoch erleichtert ein gut dokumentiertes Projekt allen Nachnutzenden den Einstieg zum Einsatz oder der Weiterentwicklung des Projekts.
An dieser Stelle finden Sie Beispiele zu diesem Thema aus unserer Community:
- Schritt für Schritt Anleitung bis zur Einbindung des Projekts als Komponente: Projekt KoliBri Get Started
- Gebrauchsanleitung für Endnutzer in verschiedenen Konfigurationen: Projekt Konformitaetstest Gebrauchsanleitung
- Quick-Start Einrichtung für Endnutzer und umfangreiche Dokumentation für Entwickelnde: Projekt Masterportal Setup, Projekt Masterportal Entwickler Dokumentation
- Kurze Installationsdokumentation mit Build-Hinweisen: Projekt Ressourcenplanung Intallation
Steuerung von Contributions
Um Interessierten und Nachnutzenden den Weg zu vereinfachen an der Weiterentwicklung eines Projekts zu partizipieren, empfiehlt es sich die Möglichkeiten und bevorzugte Kontaktwege für Projekt-Beiträge klar darzulegen.
- CONTRIBUTING-Datei mit Anleitung zu Bug Report und Pull Request: Projekt Validierungsregeln CONTRIBUTING.md
- CONTRIBUTING-Datei mit Anleitung zu Bug Report, Pull Request, FAQ, eigenem Code of Conduct und Kontaktadresse: Projekt KoliBri CONTRIBUTING.md
- Information über aktuelle Hindernisse bei der Beteiligung: Projekt Bundesmessenger
- CONTRIBUTING-Datei mit Anleitung zu Bug Report und Pull Request: Projekt OZGxPlanung CONTRIBUTING.md
Created: January 15, 2025