Badge Programm

Das Badge Programm prüft openCode Repositories und vergibt Badges, die im openCode Softwarekatalog angezeigt werden und den Status der Repositories in Bezug auf Wartung, Wiederverwendung und Sicherheit anzeigen.

Mit der Badge-API können Sie interagieren, indem Sie eine Repository-URL übermitteln. Basierend auf den erfüllten Kriterien des Repositorys erhalten Sie entsprechende Badges. Zudem stellt die API eine detaillierte Erklärung des Ergebnisses bereit.

Offizielle Badges auf openCode

Erfahren Sie mehr über die verschiedenen Arten von Badges, die auf openCode verfügbar sind, und was sie bedeuten, im Abschnitt Offizielle Badges 🛡️.

Erfahre mehr

Mehr über die Ideen hinter dem Badge-Programm, die implementierten Prüfungen usw. finden Sie im Abschnitt Konzepte.

Los geht’s

Ausprobieren

Sie können die Badge-API ausprobieren, indem Sie die API-Live-Demo verwenden.

API verwenden

Das Herzstück des Badge-Programms ist eine RESTful-API. Um die Badge-API zu nutzen, können Sie eine Repository-URL übermitteln und erhalten Badges basierend auf den erfüllten Kriterien. Eine Übersicht aller verfügbaren Endpunkte sowie deren Verwendung finden Sie in der API-Dokumentation.

Hoste die Badge-API selbst

Sie können die Badge-API selbst hosten. Wir stellen ein Helm-Chart zur Bereitstellung der Badge-API auf einem Kubernetes-Cluster zur Verfügung. Alternativ können Sie die API lokal als Container oder Bare-Metal ausführen.

Beitragen zum Badge-Programm

Wir freuen uns über Beiträge zum Badge Programm. Den Quellcode finden Sie auf openCode. Wir freuen uns, wenn Sie die Richtlinien für Beiträge befolgen. Zögern Sie nicht, ein Issue (Ticket) zu eröffnen, wenn Sie Fragen haben oder Hilfe benötigen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.