Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

Commit checklist

Viyat Bhalodia edited this page Feb 9, 2018 · 13 revisions

BEFORE committing anything please follow the steps below:

  1. Do an update: git pull (or) git fetch && git merge <-- Ensure your changes are compatible with the latest code.
  2. Do a rebase with the current branch.
  3. Re-test your changes: Run OWTF, make sure basic functionality works + what you changed is still working.
  4. Make sure everything is working as expected: run all the tests before committing: cd tests; ./run_tests.py --all.
  5. Make sure the your code is PEP-8 compliant by running (requires flake8 module.)
    FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -e '\.py$')
 
    if [ -n "$FILES" ]; then
        flake8 -r $FILES
    fi

This can also be used a pre-commit Git hook. For more information, refer to Git hooks.

  1. Once you are happy that your changes are working, please add the details to the changelog
  2. Please try to use useful commit messages with the component name, for eg. [ui], [api], etc.
  3. Send a pull request!

If you haven't read Contributing, you are recommended to read it before contributing.

NOTE: Due to the recent changes in the OWTF repo, all contributors are suggested to use a fresh clone of the repo

Clone this wiki locally