Skip to content

Commit 19bf439

Browse files
Apply suggestions from code review
Co-authored-by: Evert Lammerts <[email protected]>
1 parent 4d8c124 commit 19bf439

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@
3636
* Submitting changes to an open pull request will move it to 'draft' state.
3737
* Pull requests will get a complete run on the main repo CI only when marked as 'ready for review' (via Web UI, button on bottom right).
3838

39-
### Nightly CI
39+
### Testing cross-platform and cross-Python
4040

41-
* Packages creation and long running tests will be performed during a nightly run
42-
* On your fork you can trigger long running tests (NightlyTests.yml) for any branch following information from https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow#running-a-workflow
41+
* On your fork you can [run](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow#running-a-workflow) the Packaging workflow manually for any branch. You can choose whether to build for all platforms or a subset, and to either run the full testsuite, the fast tests only, or no tests at all.
4342

4443
## Setting up a development environment
4544

@@ -60,8 +59,11 @@ git remote add upstream https://github.com/duckdb/duckdb-python.git
6059
git fetch --all
6160
```
6261

63-
The submodule stuff is needed because we vendor the core DuckDB repository as a git submodule,
64-
and to build the python package we also need to build DuckDB itself.
62+
Two things to be aware of when cloning this repository:
63+
* DuckDB is vendored as a git submodule and needs to be initialized during or after cloning duckdb-python.
64+
* Currently, for DuckDB to determine its version while building, it depends on the local availability of its tags.
65+
66+
After forking the duckdb-python repo we recommend you clone your fork as follows:
6567

6668
### Submodule update hook
6769

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<a href="https://duckdb.org/docs/stable/clients/python/overview">API Docs (Python)</a>
2020
</p>
2121

22-
# The Official Python bindings to [DuckDB](https://github.com/duckdb/duckdb)
22+
# The [DuckDB](https://github.com/duckdb/duckdb) Python Package
2323

2424
## Installation
2525

0 commit comments

Comments
 (0)