docs: update contributing guide with uv development setup#66
docs: update contributing guide with uv development setup#66danieljrc888 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>
📝 WalkthroughWalkthroughUpdated CONTRIBUTING.md to replace multiple setup and installation subsections with a streamlined workflow emphasizing uv for dependency management and testing. The changes consolidate instructions by removing redundant options and directing developers to use Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
38-53: Add explicit Python version prerequisite before setup commands.Please state the required Python version (>=3.12) in this section so contributors don’t hit environment mismatch issues before running
uv sync.Based on learnings: Use Python >= 3.12 for development and ensure dependencies are synced via
uv syncfrom the lockfile.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 38 - 53, Update the "1.3. Setup the package locally" section to add an explicit Python prerequisite line stating "Python >= 3.12" before the clone/install commands, and mention that contributors should use that Python version when running `uv sync`; also note to run `uv sync` against the lockfile (e.g., use the project's lockfile) so dependencies are deterministic.
🤖 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-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.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 38-53: Update the "1.3. Setup the package locally" section to add
an explicit Python prerequisite line stating "Python >= 3.12" before the
clone/install commands, and mention that contributors should use that Python
version when running `uv sync`; also note to run `uv sync` against the lockfile
(e.g., use the project's lockfile) so dependencies are deterministic.
| $ git clone https://github.com/genlayerlabs/genlayer-testing-suite.git | ||
| $ cd genlayer-testing-suite | ||
| $ uv sync |
There was a problem hiding this comment.
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 gltestAlso 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 participant
Summary
uv sync,uv run gltest)Test plan
uv syncanduv run gltestwork as documented🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes