From 4c8b3b04da0baf8596f04ae3c3032d339e5ce09b Mon Sep 17 00:00:00 2001 From: Shreya Date: Mon, 26 Apr 2021 18:25:34 +0530 Subject: [PATCH] Add Swimm details to dev env setup guide in docs --- docs/content/development/setup-development-environment.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/content/development/setup-development-environment.md b/docs/content/development/setup-development-environment.md index b7d122778..097e5713d 100644 --- a/docs/content/development/setup-development-environment.md +++ b/docs/content/development/setup-development-environment.md @@ -31,3 +31,9 @@ Pre-commit is a multi-language package manager for pre-commit hooks. It will run Our CI system runs the same checks when pull requests are submitted. This system may report that the build has failed if the pre-commit hooks have not been run or all issues have not been resolved. To install and configure pre-commit, 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`. Pre-commit will now run automatically 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](../swimm).