Skip to content

docs: update contributing guide with uv development setup#68

Open
danieljrc888 wants to merge 1 commit intomainfrom
docs/update-contributing-uv-setup
Open

docs: update contributing guide with uv development setup#68
danieljrc888 wants to merge 1 commit intomainfrom
docs/update-contributing-uv-setup

Conversation

@danieljrc888
Copy link
Contributor

@danieljrc888 danieljrc888 commented Mar 1, 2026

Summary

  • Replace outdated pip-based dev setup instructions in CONTRIBUTING.md with uv commands (uv sync --group dev, uv run pytest)
  • Add a note linking to the uv installation guide for new contributors

Test plan

  • Verify the CONTRIBUTING.md renders correctly on GitHub
  • Verify uv sync --group dev and uv run pytest work as documented

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated contributor setup instructions to streamline the local development process by consolidating setup steps and using uv for dependency management and running tests.

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 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 1, 2026

📝 Walkthrough

Walkthrough

Updates CONTRIBUTING.md to replace pip-based local package installation with a unified development setup workflow using uv sync --group dev and uv run pytest for dependency management and testing.

Changes

Cohort / File(s) Summary
Documentation Setup Update
CONTRIBUTING.md
Consolidates SDK setup instructions to use uv for dependency installation and test execution, removing separate pip installation steps and editable mode guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • MuncleUscles
  • cristiam86

Poem

🐰 With uv we hop along,
Dependencies managed right and strong,
No more pip steps to recite,
Setup's simpler, smooth, and tight! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating the contributing guide with uv-based development setup instructions, which aligns with the core purpose of the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/update-contributing-uv-setup

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 41-45: Remove the shell prompt characters from the fenced code
blocks in CONTRIBUTING.md: replace lines containing "$ git clone
https://github.com/genlayerlabs/genlayer-py.git", "$ cd genlayer-py", "$ uv sync
--group dev", and "$ uv run pytest" with the same commands without the leading
"$" so the code blocks show raw commands (e.g., "git clone ...", "cd
genlayer-py", "uv sync --group dev", "uv run pytest") to satisfy markdownlint
MD014; ensure both occurrences (the blocks around the initial clone/sync and the
pytest block) are updated.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6ccabde and bf11790.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment on lines 41 to 45
```sh
$ git clone https://github.com/genlayerlabs/genlayer-py.git
$ cd genlayer-py
$ uv sync --group dev
```
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Remove shell prompts to satisfy markdownlint MD014.

Line 42, Line 43, Line 44, and Line 50 use $ prompts without output, which triggers lint warnings.

💡 Proposed docs-only fix
    ```sh
-   $ git clone https://github.com/genlayerlabs/genlayer-py.git
-   $ cd genlayer-py
-   $ uv sync --group dev
+   git clone https://github.com/genlayerlabs/genlayer-py.git
+   cd genlayer-py
+   uv sync --group dev
    ```
@@
    ```sh
-   $ uv run pytest
+   uv run pytest
    ```

Also applies to: 49-51

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[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)


[warning] 44-44: 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 - 45, Remove the shell prompt characters
from the fenced code blocks in CONTRIBUTING.md: replace lines containing "$ git
clone https://github.com/genlayerlabs/genlayer-py.git", "$ cd genlayer-py", "$
uv sync --group dev", and "$ uv run pytest" with the same commands without the
leading "$" so the code blocks show raw commands (e.g., "git clone ...", "cd
genlayer-py", "uv sync --group dev", "uv run pytest") to satisfy markdownlint
MD014; ensure both occurrences (the blocks around the initial clone/sync and the
pytest block) are updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant