Skip to content

docs: update contributing guide with uv development setup #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danieljrc888 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update contributing guide with uv development setup #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,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 package locally**: clone the repository
- **1.3. Setup the package locally**: clone the repository and install dependencies

```sh
$ git clone https://github.com/genlayerlabs/genlayer-testing-suite.git
$ cd genlayer-testing-suite
$ uv sync
Comment on lines 41 to +43
Copy link

@coderabbitai coderabbitai bot Mar 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix markdownlint MD014 warnings in command blocks.

Line 41, Line 42, Line 43, and Line 49 use $ prompts without command output, which triggers MD014. Remove the leading $ to match the repo’s linting expectations.

Suggested doc fix 
-  $ git clone https://github.com/genlayerlabs/genlayer-testing-suite.git
-  $ cd genlayer-testing-suite
-  $ uv sync
+  git clone https://github.com/genlayerlabs/genlayer-testing-suite.git
+  cd genlayer-testing-suite
+  uv sync
...
-  $ uv run gltest
+  uv run gltest

Also applies to: 49-49

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 41-41: Dollar signs used before commands without showing output

(MD014, commands-show-output)

[warning] 42-42: Dollar signs used before commands without showing output

(MD014, commands-show-output)

[warning] 43-43: Dollar signs used before commands without showing output

(MD014, commands-show-output)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 41 - 43, Remove the leading "$" prompt
characters from the command examples in the CONTRIBUTING.md command blocks so
they are plain commands (e.g., "git clone
https://github.com/genlayerlabs/genlayer-testing-suite.git", "cd
genlayer-testing-suite", "uv sync" and the similar command later in the file);
edit those lines to drop the "$" prefix to satisfy markdownlint MD014 and keep
command blocks free of prompt characters.

```

- **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-testing-suite
```
- **Option 2:** Install the package in editable mode

```sh
$ pip install -e path/to/genlayer-testing-suite --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/)
You can then run tests with:

```sh
$ uv run gltest
```

> **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
Expand Down