Mitwirken on DefectDojo Documentation

Zu Parsern beitragen

Mon, 01 Jan 0001 00:00:00 +0000

Alle Befehle setzen voraus, dass Sie sich im Root-Verzeichnis des geklonten django-DefectDojo-Repos befinden.

Voraussetzungen

Sie haben https://github.com/DefectDojo/django-DefectDojo geforkt und lokal geklont.
Wechseln Sie zu dev und stellen Sie sicher, dass Sie mit den neuesten Änderungen auf dem aktuellen Stand sind.
Es wird empfohlen, für Ihre Entwicklung einen eigenen Branch zu erstellen, etwa mit git checkout -b parser-name.

Am einfachsten ist die Verwendung des Docker-Compose-Deployments, da dieses eine Hot-Reload-Funktion für uWSGI bietet. Richten Sie Ihre Umgebung für die Verwendung der Dev-Umgebung ein:

Vorlage für Parser-Dokumentation

Mon, 01 Jan 0001 00:00:00 +0000

Diese Vorlage dient dazu, einen neuen oder bestehenden Parser zu dokumentieren. Ergänzen Sie sie gerne um weitere Informationen, die anderen Sicherheitsfachleuten helfen können.

Open-Source-Branching und Releases

Mon, 01 Jan 0001 00:00:00 +0000

Reguläre Releases

Das DefectDojo-Team strebt folgenden Rhythmus an:

Minor-Releases: mindestens einmal pro Monat, am ersten Montag des Monats.
Patch/Bugfix: Releases jede Woche am Montag.
Security-Releases: erfolgen je nach Schweregrad außerhalb unseres regulären Rhythmus.

GitHub Actions sind die maßgebliche Quelle. Die Releases sind teilautomatisiert. Die Schritte für ein reguläres Release sind:

Dokumentation ändern

Mon, 01 Jan 0001 00:00:00 +0000

Die Dokumentation wird mit Hugo erstellt und verwendet eine Variante des Doks-Themes.

Statische Dateien für die Website werden mit GitHub Actions erstellt und im gh-pages-Branch veröffentlicht.