From 4bae2da2eed856be5a127db421f61c834aef0492 Mon Sep 17 00:00:00 2001 From: Feist Josselin Date: Thu, 9 Dec 2021 09:55:18 +0100 Subject: [PATCH] Update contributing.md with crytic-compile info Add information on how to synchronize with crytic-compile --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6cc6d24a5..99447671f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,3 +56,11 @@ To see the tests coverage, run `pytest tests/test_detectors.py --cov=slither/d - Run `pytest ./tests/test_ast_parsing.py` and check that everything worked. To see the tests coverage, run `pytest tests/test_ast_parsing.py --cov=slither/solc_parsing --cov-branch --cov-report html` + +### Synchronization with crytic-compile +By default, `slither` follows either the latest version of crytic-compile in pip, or `crytic-compile@master` (look for dependencies in [`setup.py`](./setup.py). If crytic-compile development comes with breaking changes, the process to update `slither` is: +- Update `slither/setup.py` to point to the related crytic-compile's branch +- Create a PR in `slither` and ensure it passes the CI +- Once the development branch is merged in `crytic-compile@master`, ensure `slither` follows the `master` branch + +The `slither`'s PR can either be merged while using a crytic-compile non-`master` branch, or kept open until the breaking changes are available in `crytic-compile@master`.