CONTRIBUTING.md

How to Contribute

Table of Contents

• Reporting Bugs
• Suggesting Enhancements
• Submitting Changes
• Styleguides
  • GIT Commit Messages
  • Code Conventions
• Testing
• Versioning
• Suggested Development Environment
• Resources

Reporting Bugs

• Bugs are tracked as GitHub issues
• Use the Bug label
• Include as many details as possible
• Include steps to recreate the bug
• Include impacted version(s)

Suggesting Enhancements

• Enhancements are tracked as GitHub issues
• Use the Enhancement label
• Include as many details as possible

Submitting Changes

• Review the styleguides below before commencing
• Create a branch for focused development of a specific issue
• Submit a pull request using the pull request template

Styleguides

GIT Commit Messages

• Keep messages short and simple
• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Reference issues and pull requests

Python Conventions

• Please follow the PEP 8 Style Guide for Python Code

Testing

• TBC

Versioning

• TBC

Suggested Development Environment

• It's recommended to use a Virtual Environment, to prevent dependency issues.

Using virtualenv

Read more here

Create

python3 -m venv env
source env/bin/activate

Activate

source env/bin/activate

Deactivate

deactivate

Resources

Useful documentation and examples

• https://github.com/SecureAuthCorp/impacket/blob/master/impacket/smbconnection.py
• https://github.com/SecureAuthCorp/impacket/blob/429f97a894d35473d478cbacff5919739ae409b4/impacket/smbconnection.py
• https://docs.python.org/2/howto/argparse.html