Skip to content

Update CONTRIBUTING.md#121

Merged
visahak merged 2 commits intomainfrom
gaodan-fang-patch-4
Mar 31, 2026
Merged

Update CONTRIBUTING.md#121
visahak merged 2 commits intomainfrom
gaodan-fang-patch-4

Conversation

@gaodan-fang
Copy link
Copy Markdown
Collaborator

@gaodan-fang gaodan-fang commented Mar 31, 2026

Summary by CodeRabbit

  • Documentation
    • Updated setup examples so virtual environment activation comes before running dependency sync.
    • Clarified venv creation with an explicit Python 3.12 example and separated the dependency sync into its own step after activation.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 31, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3b7ed42f-8293-4205-8d0b-ce3b628ccacf

📥 Commits

Reviewing files that changed from the base of the PR and between 19d74bc and 8c1c379.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Documentation-only updates: adjusted virtual-environment setup command sequencing in CONTRIBUTING.md and README.md to create/activate the venv before running uv sync, and added an explicit uv sync after activation in README examples.

Changes

Cohort / File(s) Summary
Contribution guide
CONTRIBUTING.md
Reordered example commands to activate the virtual environment before running uv sync; updated both generic and --python 3.12 examples to show activation first, then uv sync as a separate step.
Repository README
README.md
Updated Quick Start venv example to use uv venv --python=3.12 && source .venv/bin/activate and added an explicit uv sync after activation to install dependencies.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • vinodmut
  • illeatmyhat

Poem

🐰 I hopped through docs with a careful clap,
Activate first, then run the syncy tap.
Commands aligned, no more stumble or slip,
New contributors bounce on a confident trip. 🥕✨

🚥 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 'Update CONTRIBUTING.md' is partially related to the changeset. While it accurately describes one file that was modified, the PR also includes significant updates to README.md, and the underlying intent is to update virtual environment setup command sequencing across both files. The title does not capture the primary technical change or the full scope of the PR.
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
  • Commit unit tests in branch gaodan-fang-patch-4

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.

@visahak
Copy link
Copy Markdown
Collaborator

visahak commented Mar 31, 2026

can you also update the readme? https://github.com/AgentToolkit/altk-evolve?tab=readme-ov-file#installation so the instructions are consistent.

@gaodan-fang gaodan-fang requested a review from visahak March 31, 2026 17:44
@visahak visahak merged commit 6945ce1 into main Mar 31, 2026
16 checks passed
@visahak visahak deleted the gaodan-fang-patch-4 branch March 31, 2026 19:58
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.

2 participants