Contribuindo on DefectDojo Documentation

Contribuir com Parsers

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

Todos os comandos assumem que você está na raiz do repositório clonado django-DefectDojo.

Pré-requisitos

Você fez um fork de https://github.com/DefectDojo/django-DefectDojo e clonou localmente.
Faça checkout de dev e certifique-se de estar atualizado com as últimas mudanças.
É recomendável criar um branch dedicado para o seu desenvolvimento, como git checkout -b parser-name.

A forma mais fácil é usar a implantação via docker compose, pois ela tem capacidade de hot-reload para o uWSGI. Configure seu ambiente para usar o ambiente de dev:

Template de Documentação de Parser

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

Este template foi criado para documentar um parser novo ou existente. Sinta-se à vontade para melhorá-lo com qualquer informação adicional que possa ajudar seus colegas profissionais de segurança.

Branching e Releases do Open-Source

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

Releases regulares

A equipe do DefectDojo busca manter a seguinte cadência:

Releases menores (minor): pelo menos uma vez por mês, na primeira segunda-feira do mês.
Patch/Bugfix: releases toda semana, às segundas-feiras.
Releases de segurança: serão realizadas fora da nossa cadência regular, dependendo da severidade.

As GitHub Actions são a fonte da verdade. Os releases são semiautomatizados. As etapas de um release regular são:

Editar a Documentação

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

A documentação é construída com Hugo e usa uma variação do tema Doks.

Os arquivos estáticos do site são gerados com Github actions e publicados no branch gh-pages.