From bf11790cc918bd6a28ace289d12d6128712bb360 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Sat, 28 Feb 2026 19:33:16 -0500 Subject: [PATCH] docs: update contributing guide with uv development setup Replace the outdated pip-based development setup instructions with uv sync/run commands, matching the project's migration to uv for dependency management. Co-Authored-By: Claude Opus 4.6 --- CONTRIBUTING.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cbeab2..7a0d31b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,23 +36,21 @@ Have ideas for new features or use cases? We're eager to hear them! But first: - **1.2. Create a branch**: create the branch that you will work on by using the link provided in the issue details page (right panel at the bottom - section "Development") -- **1.3. Setup the SDK locally**: clone the repository +- **1.3. Setup the SDK locally**: clone the repository and install dependencies ```sh $ git clone https://github.com/genlayerlabs/genlayer-py.git + $ cd genlayer-py + $ uv sync --group dev ``` -- **1.4. Add the package to your project locally**: to add the package locally, use the command: - - **Option 1:** Install the package in regular mode - ```sh - $ pip install path/to/genlayer-py - ``` - - **Option 2:** Install the package in editable mode - - ```sh - $ pip install -e path/to/genlayer-py --config-settings editable_mode=strict - ``` - This will allow you to use the package in your project without publishing it. With option 1 you need to re-install the package on every changes you make and with option 2 you only need to perform a re-installation if you change the project metadata. You can find more information in the pip [documentation](https://pip.pypa.io/en/stable/topics/local-project-installs/) + This will install all dependencies including dev tools. You can then run tests with: + + ```sh + $ uv run pytest + ``` + + > **Note**: This project uses [uv](https://docs.astral.sh/uv/) for dependency management. If you don't have it installed, see the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/). #### 2. Submit your solution