Skip to content

Commit

Permalink
docs: 📝 git clone methods are extended and shallow copy method also a…
Browse files Browse the repository at this point in the history
…dded

Signed-off-by: Onuralp SEZER <[email protected]>
  • Loading branch information
onuralpszr committed Nov 19, 2024
1 parent 7ea4b2a commit 85a298f
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,15 +128,27 @@ PRs must pass all tests and linting requirements before they can be merged.

Before starting your work on the project, set up your development environment:

1. Clone your fork of the project:
1. Clone your fork of the project (recommended to use shallow clone of develop branch):

**Option A: Full repository clone (if you need complete history):**

```bash
git clone https://github.com/YOUR_USERNAME/supervision.git
cd supervision
git checkout develop
```

**Option B: Recommended for most contributors (shallow clone of develop branch):**

```bash
git clone --depth 1 -b develop https://github.com/YOUR_USERNAME/supervision.git
cd supervision
```

Replace `YOUR_USERNAME` with your GitHub username.

> Note: Using `--depth 1` creates a shallow clone with minimal history and `-b develop` ensures you start with the development branch. This significantly reduces download size while providing everything needed to contribute.

2. Create and activate a virtual environment:

```bash
Expand Down

0 comments on commit 85a298f

Please sign in to comment.