|
2 | 2 |
|
3 | 3 | Here are a few things to keep in mind when making changes to DefectDojo. |
4 | 4 |
|
5 | | -## Modifying DefectDojo and testing with Vagrant |
| 5 | +## Modifying DefectDojo and Testing |
6 | 6 |
|
7 | | -This may change in the future, but for now the bash setup and Vagrant setup are |
8 | | -fairly decoupled. |
| 7 | +Please use [these test scripts](./tests) to test your changes. These are the exact scripts we run in our [Travis Build](https://travis-ci.org/OWASP/django-DefectDojo) |
9 | 8 |
|
10 | | -If you want to make changes to the DefectDojo code and test it with Vagrant, |
11 | | -you will need to change the `dd_git_repo` and/or `dd_git_branch` variables |
12 | | -defined in [__ansible/vars.yml__][ansible_vars]. You will also need to port any |
13 | | -changes you make to [__dojo/settings.dist.py__][dojo_settings] into |
14 | | -[__ansible/roles/webserver/templates/settings.j2__][ansible_settings], adding |
15 | | -Ansible variables as necessary (defined in |
16 | | -[__ansible/vars.yml__][ansible_vars]). Any additional pip packages will need to |
17 | | -be defined in [__ansible/roles/webserver/tasks/app.yml__][ansible_app]. |
| 9 | +For changes that require additional settings. settings.dist.py is the file you want to change. settings.py is populated by setup.bash from settings.dist.py |
18 | 10 |
|
19 | | -## Submitting pull requests |
| 11 | +## Submitting Pull Requests |
20 | 12 |
|
21 | 13 | The following are things to consider before submitting a pull request to |
22 | 14 | DefectDojo. |
23 | 15 |
|
24 | 16 | 0. Ensure all changes made to the code, packages, etc. are reflected in the |
25 | | -[__setup.bash__][setup_bash] script, the [__setup.py__][setup_py] script, and |
26 | | -the Ansible playbooks in the [__ansible/__][ansible_folder] folder. See |
27 | | -[__Modifying DefectDojo and testing with Vagrant__][modifying_dojo] above for |
28 | | -more information. |
| 17 | +[__setup.bash__][setup_bash] script and the [__setup.py__][setup_py] script. |
29 | 18 |
|
30 | | -0. If possible, make sure that both the bash and Vagrant installation scripts |
31 | | -are working properly before submitting a pull request. |
32 | 19 |
|
33 | | -0. All submitted code should conform to [__PEP8 standards__][pep8]. |
| 20 | +0. Make sure that the install is working properly. |
| 21 | + |
| 22 | +0. All tests found in [these test scripts](./tests) should be passing. |
34 | 23 |
|
| 24 | +0. All submitted code should conform to [__PEP8 standards__][pep8]. |
35 | 25 |
|
36 | | -[ansible_vars]: /ansible/vars.yml "Ansible variables file" |
37 | 26 | [dojo_settings]: /dojo/settings.dist.py "DefectDojo settings file" |
38 | | -[ansible_settings]: /ansible/roles/webserver/templates/settings.j2 "Ansible settings template" |
39 | 27 | [setup_py]: /setup.py "Python setup script" |
40 | | -[ansible_app]: /ansible/roles/webserver/tasks/app.yml "Ansible app tasks" |
41 | 28 | [setup_bash]: /setup.bash "Bash setup script" |
42 | | -[ansible_folder]: /ansible "Ansible folder" |
43 | | -[modifying_dojo]: #modifying-defectdojo-and-testing-with-vagrant "Modifying DefectDojo and testing with Vagrant" |
44 | 29 | [pep8]: https://www.python.org/dev/peps/pep-0008/ "PEP8" |
0 commit comments