Skip to content

docs: clarify Yarn setup for contributors#1358

Merged
brendan-kellam merged 1 commit into
sourcebot-dev:mainfrom
royalpinto007:docs/clarify-yarn-setup
Jun 23, 2026
Merged

docs: clarify Yarn setup for contributors#1358
brendan-kellam merged 1 commit into
sourcebot-dev:mainfrom
royalpinto007:docs/clarify-yarn-setup

Conversation

@royalpinto007

@royalpinto007 royalpinto007 commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Fixes #1357

Summary

  • keep the Corepack install step
  • enable Corepack so the repo uses the pinned Yarn version
  • remove the separate global Yarn install step

Verification

  • yarn install --immutable
  • yarn workspace @sourcebot/query-language test --run

Summary by CodeRabbit

  • Documentation
    • Updated development setup instructions to use Corepack with the repository's pinned Yarn version
    • Corrected grammar in the "Understanding the Licenses" section

@royalpinto007 royalpinto007 force-pushed the docs/clarify-yarn-setup branch from ee91994 to 2f6850e Compare June 21, 2026 20:09
@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cc71aa15-abfc-45b6-a816-d4e58b28fb66

📥 Commits

Reviewing files that changed from the base of the PR and between 483e495 and 02fb2f1.

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

Walkthrough

CONTRIBUTING.md corrects a grammar error ("builds and maintain" → "builds and maintains") and replaces the npm-based global Corepack/Yarn installation steps with corepack enable and a yarn --version verification step that uses the repo's pinned Yarn version.

Changes

Contributor setup documentation update

Layer / File(s) Summary
Corepack setup steps and grammar fix
CONTRIBUTING.md
Fixes "builds and maintain" → "builds and maintains" in the licensing section; replaces npm-based global Yarn installation with corepack enable and yarn --version verification in the Developing Sourcebot setup steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • sourcebot-dev/sourcebot#886: Contains prior documentation-only edits to CONTRIBUTING.md, directly overlapping with the file modified in this PR.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: clarify Yarn setup for contributors' clearly and concisely summarizes the main change: updating documentation to clarify the Yarn setup process.
Linked Issues check ✅ Passed The PR successfully addresses issue #1357 by removing global Yarn installation steps and leveraging Corepack with the repository's pinned Yarn version, exactly as required.
Out of Scope Changes check ✅ Passed All changes are limited to CONTRIBUTING.md with grammar corrections and setup instruction updates directly aligned with issue #1357 objectives.
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

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.

@royalpinto007 royalpinto007 force-pushed the docs/clarify-yarn-setup branch from 2f6850e to 2329333 Compare June 21, 2026 20:13

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c127b9 and 2f6850e.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • CONTRIBUTING.md

Comment thread CHANGELOG.md Outdated
Comment thread CONTRIBUTING.md Outdated
@royalpinto007 royalpinto007 force-pushed the docs/clarify-yarn-setup branch from 2329333 to 483e495 Compare June 21, 2026 20:14
@royalpinto007 royalpinto007 force-pushed the docs/clarify-yarn-setup branch from 483e495 to 02fb2f1 Compare June 21, 2026 20:17

@brendan-kellam brendan-kellam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@brendan-kellam brendan-kellam merged commit a8d9b7c into sourcebot-dev:main Jun 23, 2026
4 of 5 checks passed
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.

Clarify Yarn setup in CONTRIBUTING

2 participants