Contributing

Contributing to WAFW00F

First of all thank you for your interest in WAFW00F Development!

Conditions

You pull request must be satisfying one of these categories:

• A new feature/enhancement.
• Fix an issue/feature-request .
• An improvement to existing plugin (fingerprint updation, insertion, etc).

Pull requests other than these (eg. adding a new banner) will NOT be entertained.

For New Pull Requests

• The pull request should be targeted at the dev branch, not to any other branch.
• The code must be reproducible on all platforms (Linux, Windows, Mac, etc).
• A reference needs to be added whether this does add any new dependency or not.
• A mentioned is needed whether the new PR does add any new arguments to the existing set.
• If possible the output should be included, especially for witness-able effects in console.
• The pull request description should not be preferably kept blank.
• The build should be tested properly before submitting the PR.

Code Contribution Tips:

• Code should follow the Python PEP 8 style guide.
• The Python indentation should be 4 spaces.
• The code should be licensed under the same BSD 3 Clause license.
• Well documented code is appreciated, so that other folks will know whats going on under the hood.

Next, you might want to have a look at contributing new plugins to WAFW00F.