Contribuire on DefectDojo Documentation

Contribuire ai Parser

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

Tutti i comandi presuppongono che tu ti trovi nella radice del repository clonato django-DefectDojo.

Prerequisiti

Hai eseguito il fork di https://github.com/DefectDojo/django-DefectDojo e lo hai clonato localmente.
Esegui il checkout di dev e assicurati di essere aggiornato con le ultime modifiche.
Si consiglia di creare un branch dedicato per il tuo sviluppo, come git checkout -b parser-name.

È più semplice utilizzare il deployment con docker compose poiché offre la capacità di hot-reload per uWSGI. Configura il tuo ambiente per utilizzare l’ambiente dev:

Modello di documentazione del parser

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

Questo modello è pensato per documentare un parser nuovo o esistente. Sentiti libero di migliorarlo con qualsiasi informazione aggiuntiva che possa aiutare i tuoi colleghi professionisti della sicurezza.

Branching e Release Open-Source

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

Release regolari

Il team di DefectDojo punta a mantenere il seguente ritmo:

Release minori: almeno una volta al mese, il primo lunedì del mese.
Patch/Bugfix: release ogni settimana di lunedì.
Release di sicurezza: verranno eseguite al di fuori del nostro ritmo regolare, a seconda della gravità.

GitHub Actions è la fonte autorevole. Le release sono semi-automatizzate. I passaggi per una release regolare sono:

Modificare la documentazione

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

La documentazione è realizzata con Hugo e utilizza una variante del tema Doks.

I file statici del sito web vengono creati con GitHub Actions e pubblicati nel branch gh-pages.