From 1883abaa236faaba28fa2db2aa68d6cc7b6c289a Mon Sep 17 00:00:00 2001 From: "ori.agmon" Date: Sun, 14 Oct 2018 16:04:37 +0300 Subject: [PATCH] Updated read me for devs so the mistake won't happen again --- src/README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/README.md b/src/README.md index 80f3612..868eb65 100644 --- a/src/README.md +++ b/src/README.md @@ -71,7 +71,10 @@ _The file's (module's) content is imported automatically"_ The second step is to determine what events your Hunter will subscribe to, and from where you can get them. `Convention:` Events should be declared in their corresponding module. for example, a KubeDashboardEvent event is declared in the dashboard discovery module. - + +`Note:` An hunter located under the `disovery` folder should not import any modules located under the `hunting` folder +in order to prevent circular dependency bugs + Following the above example, let's figure out the imports: ```python from ...core.types import Hunter @@ -114,7 +117,7 @@ relative import: `...core.types` ## Creating Events -As discussed above, we know there are alot of different types of events that can be created. but at the end, they all need to inherit from the base class `Event` +As discussed above, we know there are a lot of different types of events that can be created. but at the end, they all need to inherit from the base class `Event` lets see some examples of creating different types of events: ### Vulnerability ```python