Skip to content

Commit fc1684e

Browse files
committed
Better contribute instructions
1 parent 119fc47 commit fc1684e

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,22 @@ pip install 'duckdb[all]'
4646

4747
### Cloning
4848

49-
When you clone the repo or your fork, make sure you initialize the duckdb submodule:
49+
After forking this duckdb-python, we recommend you clone your fork as follows:
5050
```shell
51-
git clone --recurse-submodules <repo>
51+
git clone --recurse-submodules $REPO_URL
52+
git remote add upstream https://github.com/duckdb/duckdb-python.git
53+
git fetch --all
5254
```
5355

54-
... or, if you already have the repo locally:
56+
... or, if you have already cloned your fork:
5557
```shell
56-
git clone <your-repo>
57-
cd <your-repo>
5858
git submodule update --init --recursive
59+
git remote add upstream https://github.com/duckdb/duckdb-python.git
60+
git fetch --all
5961
```
6062

63+
### Submodule update hook
64+
6165
If you'll be switching between branches that are have the submodule set to different refs, then make your life
6266
easier and add the git hooks in the .githooks directory to your local config:
6367
```shell
@@ -78,7 +82,7 @@ git config --local core.hooksPath .githooks/
7882

7983
```bash
8084
# install all dev dependencies without building the project (needed once)
81-
uv sync -p 3.9 --no-install-project
85+
uv sync -p 3.11 --no-install-project
8286
# build and install without build isolation
8387
uv sync --no-build-isolation
8488
```

0 commit comments

Comments
 (0)