Contributing on DefectDojo Documentation

Contribute to Parsers

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

All commands assume that you’re located at the root of the django-DefectDojo cloned repo.

Pre-requisites

You have forked https://github.com/DefectDojo/django-DefectDojo and cloned locally.
Checkout dev and make sure you’re up to date with the latest changes.
It’s advised that you create a dedicated branch for your development, such as git checkout -b parser-name.

It is easiest to use the docker compose deployment as it has hot-reload capability for uWSGI. Set up your environment to use the dev environment:

Parser Documentation Template

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

This template is designed to document a new or existing parser. Please feel free to improve with any additional information that might help your fellow security professionals.

Open-Source Branching & Releases

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

Regular releases

All releases come from the dev branch. The DefectDojo team aims to maintain the following cadence:

Minor releases: at least once a month on the first Monday of the month.
Patch releases: every week on Monday.
Security releases: may be cut outside of our regular cadence depending on severity. They also come from dev.

There is no separate branch for bug fixes and no hotfix branch off master. Every pull request, bug fix or feature, targets dev.

Amend Documentation

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

The documentation is built with Hugo and uses a variation of the Doks theme.

Static files for the website are built with Github actions and are published in the gh-pages branch.