docs: update contributing guide with uv development setup#68
docs: update contributing guide with uv development setup#68danieljrc888 wants to merge 1 commit intomainfrom
Conversation
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>
📝 WalkthroughWalkthroughUpdates Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.
| ```sh | ||
| $ git clone https://github.com/genlayerlabs/genlayer-py.git | ||
| $ cd genlayer-py | ||
| $ uv sync --group dev | ||
| ``` |
There was a problem hiding this comment.
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.
Summary
uv sync --group dev,uv run pytest)Test plan
uv sync --group devanduv run pytestwork as documented🤖 Generated with Claude Code
Summary by CodeRabbit