docs: clarify Yarn setup for contributors#1358
Conversation
ee91994 to
2f6850e
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
Walkthrough
ChangesContributor setup documentation update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
2f6850e to
2329333
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CHANGELOG.md`:
- Around line 13-15: The CHANGELOG.md file contains an entry for a
documentation-only change under the "Unreleased" section, but repository
guidelines require that documentation-only updates should not have CHANGELOG
entries. Remove the bullet point that references the contributor setup guide and
Corepack change (PR `#1358`) from the "Changed" subsection under "Unreleased" in
the CHANGELOG.md file.
In `@CONTRIBUTING.md`:
- Around line 58-61: Move the `yarn --version` command to execute after the
repository is cloned and the working directory is changed to sourcebot, rather
than before cloning. Remove `yarn --version` from step 3 (the Corepack enable
block), then add both `cd sourcebot` and `yarn --version` to step 4 (after the
git clone command), remove `cd sourcebot` from step 5, and renumber steps 4 and
5 to become steps 5 and 6 respectively to fix the duplicate step numbering.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c652ba24-130b-473e-8ef6-0f9bb1bc8484
📒 Files selected for processing (2)
CHANGELOG.mdCONTRIBUTING.md
2329333 to
483e495
Compare
483e495 to
02fb2f1
Compare
Fixes #1357
Summary
Verification
yarn install --immutableyarn workspace @sourcebot/query-language test --runSummary by CodeRabbit