mirror of
https://github.com/laramies/theHarvester.git
synced 2024-09-22 16:26:34 +08:00
18 lines
659 B
Markdown
18 lines
659 B
Markdown
|
# Contributing to theHarvester Project
|
||
|
|
Welcome to theHarvester project, so you would like to contribute.
|
||
|
|
|
||
|
|
The following below must be met to get accepted.
|
||
|
|
|
||
|
|
# CI
|
||
|
|
Make sure all CI passes and you do not introduce any alerts from lgtm.
|
||
|
|
|
||
|
|
# Unit Tests
|
||
|
|
For new modules a unit test for that module is required and we use pytest.
|
||
|
|
|
||
|
|
# Coding Standards
|
||
|
|
* No single letter variables and variable names must represent the action that it is performing
|
||
|
|
* Have static typing on functions etc
|
||
|
|
|
||
|
|
# Submitting Bugs
|
||
|
|
If you have a bug in a module that you want to submit an issue for and know how to write python code.
|
||
|
|
Please create a unit test for that bug and submit a fix for it
|