From 60f776fef945e65a780b0f4487dd4b3c309e629a Mon Sep 17 00:00:00 2001 From: Shreya Date: Mon, 26 Apr 2021 19:00:40 +0530 Subject: [PATCH] Add Swimm details to deployment guide (deployment_scripts/README.md) --- deployment_scripts/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/deployment_scripts/README.md b/deployment_scripts/README.md index 7f4e414bd..aed00ae58 100644 --- a/deployment_scripts/README.md +++ b/deployment_scripts/README.md @@ -85,3 +85,9 @@ been run or all issues have not been resolved. To install and configure pre-commit manually, run `pip install --user pre-commit`. Next, go to the top level directory of this repository and run `pre-commit install -t pre-commit -t pre-push` Now, pre-commit will automatically run whenever you `git commit`. + +## Swimm + +Infection Monkey has development tutorials that use [`swimm.io`](https://swimm.io/) to help teach new developers how to perform common code tasks in the Infection Monkey codebase and accelerate the ramp-up process. The tutorials include adding new configuration values, new system info collectors and more. + +In order to pass the pre-commit checks, you'll have to [install Swimm successfully](https://www.guardicore.com/infectionmonkey/docs/development/swimm/). Both the Linux and Windows deployment scrips will install [Swimm](https://swimm.io/), but you'll have to sign up [here](https://swimm.io/sign-beta) to complete the process.