Skip to content

Guidelines

Anouar Ben Saad edited this page May 25, 2019 · 1 revision

Guidelines


Reporting Bugs

Make sure you have the latest version of vulnx with all the dependencies installed. Please follow the following layout while starting an issue for a bug:

  • Title

  • Description

  • Include brief description of the bug.

  • Output

  • Attach screenshots of the error or paste the output here. Platform os: <operating system> python: <python version>

Steps to reproduce

This section should describe how to reproduce the bug. Potential cause & fix

If you know what is causing the error or how to fix this please include that information in this section.

Pull Requests

Pull requests regarding things which aren't directly related to the program will not be merged.

For example, pull requests related to README.md, .travis.yml and .gitignore will not be merged, you can open an issue instead.

While adding a new command line argument, please keep in mind that shorthand aliases e.g. -t are only for arguments which require an additional value.

If you need to import a new non-standard library, add it to requirements.txt.

Mention the changes in changes variable in vulnx.py.

Please follow the following layout while submitting a pull request.

  • Title

  • Description

  • Include a brief description of what is it all about.

  • Tested on os: <operating system> python: <python version>

  • Dependencies

Clone this wiki locally