Development environment setup

[msukkari]

Create AGENTS.md to document Cursor Cloud-specific development instructions for the Sourcebot codebase.

  

Summary by CodeRabbit

• Documentation
  • Added a new development guide detailing system overview, setup prerequisites (Node.js 24+, Go, Docker, universal-ctags), services/ports, key development commands, local development caveats, and PR workflow.
  • Updated the changelog to note the addition of the new development guide.

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1caaa635-4a56-4654-bf97-d1295b7f0426

📥 Commits

Reviewing files that changed from the base of the PR and between 60c58e2 and a7616b3.

📒 Files selected for processing (2)

• AGENTS.md
• CHANGELOG.md

---

Walkthrough

Added a new documentation file, AGENTS.md, with Cursor Cloud-specific setup and development instructions for Sourcebot, and updated CHANGELOG.md to record the addition under Unreleased.

Changes

Cohort / File(s)	Summary
Docs: Cursor Cloud guide AGENTS.md	New documentation file describing system overview, prerequisites (Node.js 24+, Go, Docker, universal-ctags), services and ports, key development commands, local development caveats, and PR workflow requirements.
Changelog CHANGELOG.md	Added an Unreleased entry noting AGENTS.md was added (#1001).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• Development environment setup #1001 — Adds the same AGENTS.md and corresponding CHANGELOG.md entry.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The PR title 'Development environment setup' is generic and overly broad, failing to highlight the specific contribution—adding AGENTS.md for Cursor Cloud-specific development instructions.	Consider a more specific title such as 'Add AGENTS.md with Cursor Cloud development instructions' to better convey the primary change.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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
• Post copyable unit tests in a comment
• Commit unit tests in branch cursor/development-environment-setup-5c91

📝 Coding Plan

• Generate coding plan for human review comments

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

AGENTS.md (1)

45-45: Consider adding a concrete worker-check command at Line 45.

“Check logs” is directionally correct, but adding one explicit command (for example, a log filter or queue-depth check) would make this more actionable for first-time setup.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` at line 45, Replace the vague "check logs" guidance with one
concrete, copy-pasteable check: add an explicit example to the sentence (e.g., a
docker/container-logs filter that tails the worker container to look for its
startup/processing messages and a Redis/BullMQ queue-depth check that shows the
number of waiting jobs) so a first-time user can immediately run a single
command to verify the worker; update the line containing "The backend worker
does not expose a health-check endpoint" to include both a specific log-tail
command example and a specific queue-depth check example and a short note which
queue name to target.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Line 11: Update the Node.js requirement text in AGENTS.md by replacing the
current "**Node.js 24+**" phrase with the correct minimum supported version
(e.g., "**Node.js 20+**") or add a clarifying note explaining that 24+ is only
required for specific use cases; target the exact string "**Node.js 24+**" so
the change is localized and consistent with the test workflow
(.github/workflows/test.yml) which uses Node.js 20.x.

---

Nitpick comments:
In `@AGENTS.md`:
- Line 45: Replace the vague "check logs" guidance with one concrete,
copy-pasteable check: add an explicit example to the sentence (e.g., a
docker/container-logs filter that tails the worker container to look for its
startup/processing messages and a Redis/BullMQ queue-depth check that shows the
number of waiting jobs) so a first-time user can immediately run a single
command to verify the worker; update the line containing "The backend worker
does not expose a health-check endpoint" to include both a specific log-tail
command example and a specific queue-depth check example and a short note which
queue name to target.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4f15c914-8369-42e5-a84d-6a697a20736d

📥 Commits

Reviewing files that changed from the base of the PR and between 65a4560 and 60c58e2.

📒 Files selected for processing (1)

• AGENTS.md