Contribuer on DefectDojo Documentation

Contribuer aux parsers

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

Toutes les commandes supposent que vous vous trouvez à la racine du dépôt cloné django-DefectDojo.

Prérequis

Vous avez forké https://github.com/DefectDojo/django-DefectDojo et cloné le dépôt en local.
Basculez sur dev et assurez-vous d’être à jour avec les derniers changements.
Il est conseillé de créer une branche dédiée à votre développement, telle que git checkout -b parser-name.

Le plus simple est d’utiliser le déploiement docker compose, car il offre une capacité de rechargement à chaud pour uWSGI. Configurez votre environnement pour utiliser l’environnement dev :

Modèle de documentation de parser

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

Ce modèle est conçu pour documenter un parser nouveau ou existant. N’hésitez pas à l’améliorer avec toute information supplémentaire susceptible d’aider vos collègues professionnels de la sécurité.

Branches et versions Open Source

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

Versions régulières

L’équipe DefectDojo vise à maintenir la cadence suivante :

Versions mineures : au moins une fois par mois, le premier lundi du mois.
Correctifs/Bugfix : versions chaque semaine, le lundi.
Versions de sécurité : réalisées en dehors de notre cadence habituelle, selon la gravité.

Les GitHub Actions font foi. Les versions sont semi-automatisées. Les étapes d’une version régulière sont les suivantes :

Modifier la documentation

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

La documentation est construite avec Hugo et utilise une variante du thème Doks.

Les fichiers statiques du site sont générés par des Github actions et publiés dans la branche gh-pages.