Skip to content

Commit 581dd76

Browse files
committed
Adding contributing document
1 parent 3d5ec26 commit 581dd76

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

doc/contributing.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to DefectDojo
2+
3+
There are a few things to keep in mind when developing your own code for
4+
DefectDojo
5+
6+
## Modifying Application Settings
7+
8+
0. You must keep
9+
[ansible/roles/webserver/templates/settings.j2][settings_template]
10+
up to date with [dojo/settings.dist.py][dojo_settings] as you make
11+
changes to your settings if you want to install via the Vagrant provisioning
12+
script, or if you want to submit a pull request to DefectDojo. You should define
13+
any additional variables needed upon install in
14+
[ansible/vars.yml][ansible_vars]
15+
16+
0. If you want to make changes to the DefectDojo code and test it with Vagrant,
17+
you will need to change the `dd_git_repo` and/or `dd_git_branch` variables
18+
defined in [ansible/vars.yml][ansible_vars]
19+
20+
21+
[settings_template]: ../ansible/roles/webserver/templates/settings.j2 "Ansible settings template"
22+
[dojo_settings]: ../dojo/settings.dist.py "DefectDojo settings file"
23+
[ansible_vars]: ../ansible/vars.yml "Ansible variables file"

0 commit comments

Comments
 (0)