Merge pull request #1986 from crytic/update-contributing

Update contributing

CONTRIBUTING.md

@@ -81,7 +81,7 @@ For each new detector, at least one regression tests must be present.
 
 1. Create a folder in `tests/e2e/detectors/test_data` with the detector's argument name.
 2. Create a test contract in `tests/e2e/detectors/test_data/<detector_name>/`.
-3. Update `ALL_TEST` in `tests/e2e/detectors/test_detectors.py`
+3. Update `ALL_TESTS` in `tests/e2e/detectors/test_detectors.py`.
 4. Run `python tests/e2e/detectors/test_detectors.py --compile` to create a zip file of the compilation artifacts.
 5. `pytest tests/e2e/detectors/test_detectors.py --insta update-new`. This will generate a snapshot of the detector output in `tests/e2e/detectors/snapshots/`. If updating an existing detector, run `pytest tests/e2e/detectors/test_detectors.py --insta review` and accept or reject the updates.
 6. Run `pytest tests/e2e/detectors/test_detectors.py` to ensure everything worked. Then, add and commit the files to git.
@@ -97,8 +97,9 @@ For each new detector, at least one regression tests must be present.
 
 1. Create a test in `tests/e2e/solc_parsing/`
 2. Run `python tests/e2e/solc_parsing/test_ast_parsing.py --compile`. This will compile the artifact in `tests/e2e/solc_parsing/compile`. Add the compiled artifact to git.
-3. Run `python tests/e2e/solc_parsing/test_ast_parsing.py --generate`. This will generate the json artifacts in `tests/e2e/solc_parsing/expected_json`. Add the generated files to git.
-4. Run `pytest tests/e2e/solc_parsing/test_ast_parsing.py` and check that everything worked.
+3. Update `ALL_TESTS` in `tests/e2e/solc_parsing/test_ast_parsing.py`.
+4. Run `python tests/e2e/solc_parsing/test_ast_parsing.py --generate`. This will generate the json artifacts in `tests/e2e/solc_parsing/expected_json`. Add the generated files to git.
+5. Run `pytest tests/e2e/solc_parsing/test_ast_parsing.py` and check that everything worked.
 
 > ##### Helpful commands for parsing tests
 >

tests/e2e/detectors/test_detectors.py

@@ -56,7 +56,7 @@ def id_test(test_item: Test):
     return f"{test_item.detector.__name__}-{test_item.solc_ver}-{test_item.test_file}"
 
 
-ALL_TEST_OBJECTS = [
+ALL_TESTS = [
     Test(
         all_detectors.UninitializedFunctionPtrsConstructor,
         "uninitialized_function_ptr_constructor.sol",
@@ -1656,7 +1656,7 @@ GENERIC_PATH = "/GENERIC_PATH"
 TEST_DATA_DIR = Path(__file__).resolve().parent / "test_data"
 
 # pylint: disable=too-many-locals
-@pytest.mark.parametrize("test_item", ALL_TEST_OBJECTS, ids=id_test)
+@pytest.mark.parametrize("test_item", ALL_TESTS, ids=id_test)
 def test_detector(test_item: Test, snapshot):
     test_dir_path = Path(
         TEST_DATA_DIR,
@@ -1704,5 +1704,5 @@ if __name__ == "__main__":
             "To generate the zip artifacts run\n\tpython tests/e2e/tests/test_detectors.py --compile"
         )
     elif sys.argv[1] == "--compile":
-        for next_test in ALL_TEST_OBJECTS:
+        for next_test in ALL_TESTS:
             _generate_compile(next_test, skip_existing=True)