mirror of
https://github.com/laramies/theHarvester.git
synced 2024-09-20 15:26:31 +08:00
Move contributing to the correct place and file name convention
This commit is contained in:
parent
fcd2484bbb
commit
eab9b116c0
|
@ -1,6 +1,5 @@
|
|||
# Contributing to theHarvester Project
|
||||
Welcome to theHarvester project, so you would like to contribute.
|
||||
|
||||
The following below must be met to get accepted.
|
||||
|
||||
# CI
|
||||
|
@ -12,7 +11,9 @@ 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
|
||||
* Make sure no errors are reported from mypy
|
||||
* No issues reported with flake8
|
||||
|
||||
# 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
|
||||
If you find 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(If possible) and submit a fix for it as it would be a big help to the project.
|
Loading…
Reference in a new issue