From ee9faedbbeecb254c2c111fa48192065ad01d2f4 Mon Sep 17 00:00:00 2001 From: Pepe Fagoaga Date: Tue, 11 Jun 2024 18:08:54 +0200 Subject: [PATCH] docs(developer-guide): How to fork the repo (#4238) --- docs/developer-guide/introduction.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/introduction.md b/docs/developer-guide/introduction.md index 531a7f1c53..b9e6539b48 100644 --- a/docs/developer-guide/introduction.md +++ b/docs/developer-guide/introduction.md @@ -4,10 +4,14 @@ You can extend Prowler Open Source in many different ways, in most cases you wil ## Get the code and install all dependencies -First of all, you need a version of Python 3.9 or higher and also pip installed to be able to install all dependencies required. Once that is satisfied go a head and clone the repo: +First of all, you need a version of Python 3.9 or higher and also `pip` installed to be able to install all dependencies required. + +Then, to start working with the Prowler Github repository you need to fork it to be able to propose changes for new features, bug fixing, etc. To fork the Prowler repo please refer to [this guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo?tool=webui#forking-a-repository). + +Once that is satisfied go ahead and clone your forked repo: ``` -git clone https://github.com/prowler-cloud/prowler +git clone https://github.com//prowler cd prowler ``` For isolation and avoid conflicts with other environments, we recommend usage of `poetry`: