Skip to content

Commit

Permalink
Merge pull request #2032 from DefectDojo/update-contributing-master
Browse files Browse the repository at this point in the history
Update master/CONTRIBUTING.md to reflect reality after python3 upgrade
  • Loading branch information
valentijnscholten committed Mar 12, 2020
2 parents 9986e86 + 74a6f4e commit 64d5f34
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Expand Up @@ -18,13 +18,6 @@ Please use [these test scripts](./tests) to test your changes. These are the exa


For changes that require additional settings, settings.dist.py is the file you want to change. Settings.py is created by setup.bash from settings.dist.py For changes that require additional settings, settings.dist.py is the file you want to change. Settings.py is created by setup.bash from settings.dist.py


## Transition to python3

With the nearing deprecation of python 2.7, the conversion to python3 will be
executed as smoothly as possible. During this process, DefectDojo will also be
upgraded to Django 2.2.1. Going forward, the 'dev' branch will only accept
bug fixes, Please instead contribute features / bug fixes to the ‘python3_dev’ branch.

## Python3 version ## Python3 version
For compatibility reasons, the code in dev branch should be python3.5 compliant. For compatibility reasons, the code in dev branch should be python3.5 compliant.


Expand Down Expand Up @@ -56,12 +49,14 @@ DefectDojo.


0. All submitted code should conform to [__PEP8 standards__][pep8]. 0. All submitted code should conform to [__PEP8 standards__][pep8].


0. Pull requests should be submitted to the 'dev' or 'legacy-python2.7' branch. 0. See [flake8 built-in commit hooks] on how to easily check for for pep8 with flake8 before comitting.


0. In dev branch, the code should be python 3.5 compliant. 0. Pull requests should be submitted to the 'dev' branch.


0. In dev branch, the code should be python 3.5 compliant.


[dojo_settings]: /dojo/settings/settings.dist.py "DefectDojo settings file" [dojo_settings]: /dojo/settings/settings.dist.py "DefectDojo settings file"
[setup_py]: /setup.py "Python setup script" [setup_py]: /setup.py "Python setup script"
[setup_bash]: /setup.bash "Bash setup script" [setup_bash]: /setup.bash "Bash setup script"
[pep8]: https://www.python.org/dev/peps/pep-0008/ "PEP8" [pep8]: https://www.python.org/dev/peps/pep-0008/ "PEP8"
[flake8 built-in commit hooks]: https://flake8.pycqa.org/en/latest/user/using-hooks.html#built-in-hook-integration

0 comments on commit 64d5f34

Please sign in to comment.