Skip to content

Commit 362d0b4

Browse files
committed
docs: updated readme for contributing to problog model.
Signed-off-by: Carl Flottmann <[email protected]>
1 parent e145e5b commit 362d0b4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Diff for: src/macaron/malware_analyzer/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ When contributing an analyzer, it must meet the following requirements:
6161
- The analyzer name must be added to [heuristics.py](./pypi_heuristics/heuristics.py) file so it can be used for rule combinations in [detect_malicious_metadata_check.py](../slsa_analyzer/checks/detect_malicious_metadata_check.py)
6262
- Update the `malware_rules_problog_model` in [detect_malicious_metadata_check.py](../slsa_analyzer/checks/detect_malicious_metadata_check.py) with logical statements where the heuristic should be included. When adding new rules, please follow the following guidelines:
6363
- Provide a [confidence value](../slsa_analyzer/checks/check_result.py) using the `Confidence` enum.
64-
- Ensure it is assigned to the "result" string name, otherwise it will not be queried and evaluated.
65-
- Assign a string rule ID to the rule. This will be used to backtrack to determine if it was triggered.
64+
- Ensure it is assigned to the `problog_result_access` string variable, otherwise it will not be queried and evaluated.
65+
- Assign a rule ID to the rule. This will be used to backtrack to determine if it was triggered.
6666
- Make sure to wrap pass/fail statements in `passed()` and `failed()`. Not doing so may result in undesirable behaviour, see the comments in the model for more details.
6767
- If there are commonly used combinations introduced by adding the heuristic, combine and justify them at the top of the static model (see `quickUndetailed` and `forceSetup` as current examples).
6868

0 commit comments

Comments
 (0)