Create CONTRIBUTING.md#114
Conversation
adding contributing documentation to the readme.
📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 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 |
| You can use `uv` to create a virtual environment (if it doesn’t already exist) and install all project dependencies: | ||
|
|
||
| ```bash | ||
| uv venv |
There was a problem hiding this comment.
i think we need to run source .venv/bin/activate before uv sync
There was a problem hiding this comment.
Thanks. I changed it to uv sync && source .venv/bin/activate copied over from the main read me
| #### Using a specific Python version | ||
|
|
||
| ```bash | ||
| uv venv --python 3.12 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (4)
CONTRIBUTING.md (4)
63-63: Clarify thatuv.lockupdates automatically.The wording "Update
pyproject.tomlanduv.lock" might suggest manual editing of both files. In practice,uv.lockis automatically updated when you runuv addoruv sync. Consider rephrasing to:-3. Update `pyproject.toml` and `uv.lock`. +3. Update `pyproject.toml` (and `uv.lock` will be updated automatically by `uv` commands).This prevents contributors from attempting to manually edit the lock file.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 63, Change the instruction text "Update `pyproject.toml` and `uv.lock`" to clarify that contributors should manually update pyproject.toml but not edit uv.lock, because `uv.lock` is updated automatically when running `uv add` or `uv sync`; update the line containing "Update `pyproject.toml` and `uv.lock`" in CONTRIBUTING.md to something like "Update `pyproject.toml`; `uv.lock` will be updated automatically by `uv add`/`uv sync`" so contributors won’t try to manually edit the lock file.
54-54: Useuv runprefix for consistency.To align with the project's
uv-based workflow, consider runningpre-commitviauv run:uv run pre-commit run --all-filesThis ensures the command uses the project's virtual environment. Based on learnings, use
uvto run Python commands instead of running them directly.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 54, Replace the bare "pre-commit run --all-files" command in CONTRIBUTING.md with the uv-prefixed invocation so the project virtual environment is used; specifically update the line containing "pre-commit run --all-files" to read "uv run pre-commit run --all-files".
48-48: Useuv runprefix for consistency.To align with the project's
uv-based workflow, consider runningpre-commitviauv run:uv run pre-commit installThis ensures the command uses the project's virtual environment. Based on learnings, use
uvto run Python commands instead of running them directly.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 48, Update the CONTRIBUTING.md entry that currently reads "pre-commit install" to use the project's uv-run workflow by replacing that line with "uv run pre-commit install" so the pre-commit hook is installed inside the project's virtual environment (locate the exact string "pre-commit install" and update it).
78-79: Useuv runprefix for consistency.To align with the project's
uv-based workflow, consider runningdetect-secretsviauv run:uv pip install --upgrade "git+https://github.com/ibm/detect-secrets.git@master#egg=detect-secrets" uv run detect-secrets scan --update .secrets.baseline uv run detect-secrets audit .secrets.baselineThis ensures the commands use the project's virtual environment. Based on learnings, use
uvto run Python commands instead of running them directly.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 78 - 79, Update the CONTRIBUTING.md commands to run detect-secrets within the project's virtual environment: replace the direct calls to "detect-secrets scan --update .secrets.baseline" and "detect-secrets audit .secrets.baseline" with their "uv run" equivalents (and recommend installing detect-secrets via "uv pip install ..." as shown), ensuring the commands use "uv run detect-secrets" and reference ".secrets.baseline" unchanged so they execute inside the uv-managed environment.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 63: Change the instruction text "Update `pyproject.toml` and `uv.lock`"
to clarify that contributors should manually update pyproject.toml but not edit
uv.lock, because `uv.lock` is updated automatically when running `uv add` or `uv
sync`; update the line containing "Update `pyproject.toml` and `uv.lock`" in
CONTRIBUTING.md to something like "Update `pyproject.toml`; `uv.lock` will be
updated automatically by `uv add`/`uv sync`" so contributors won’t try to
manually edit the lock file.
- Line 54: Replace the bare "pre-commit run --all-files" command in
CONTRIBUTING.md with the uv-prefixed invocation so the project virtual
environment is used; specifically update the line containing "pre-commit run
--all-files" to read "uv run pre-commit run --all-files".
- Line 48: Update the CONTRIBUTING.md entry that currently reads "pre-commit
install" to use the project's uv-run workflow by replacing that line with "uv
run pre-commit install" so the pre-commit hook is installed inside the project's
virtual environment (locate the exact string "pre-commit install" and update
it).
- Around line 78-79: Update the CONTRIBUTING.md commands to run detect-secrets
within the project's virtual environment: replace the direct calls to
"detect-secrets scan --update .secrets.baseline" and "detect-secrets audit
.secrets.baseline" with their "uv run" equivalents (and recommend installing
detect-secrets via "uv pip install ..." as shown), ensuring the commands use "uv
run detect-secrets" and reference ".secrets.baseline" unchanged so they execute
inside the uv-managed environment.
2 participants
Adding contributing documentation to the readme.
Summary by CodeRabbit