docs: enhance contributing section in README by adityachoudhari26 · Pull Request #952 · ctrlplanedev/ctrlplane

adityachoudhari26 · 2026-04-09T17:08:26Z

Enhances the contributing section in README.md with detailed setup instructions, day-to-day commands, E2E test guidance, monorepo structure, code style guidelines, and PR workflow.

Resolves #913

Generated with Claude Code

Summary by CodeRabbit

Documentation
- Expanded contribution guide with comprehensive setup instructions, including Docker Compose, pnpm workflows, and database migrations
- Added day-to-day command reference for development, testing, linting, and formatting
- Included Go workspace-engine and Playwright E2E testing documentation
- Added monorepo structure overview and code-style checklist

- Add detailed prerequisites with links (Docker, Flox, pnpm, Go) - Expand first-time setup with step comments and a reset guide - Add day-to-day development commands table - Add database, E2E tests, and workspace-engine (Go) sections - Add monorepo structure overview - Add code style guidelines - Add pull request workflow instructions Co-authored-by: Aditya Choudhari <adityachoudhari26@users.noreply.github.com>

coderabbitai · 2026-04-09T17:08:42Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 051ec341-ebdd-4ebb-b636-e60570d4c9c5

📥 Commits

Reviewing files that changed from the base of the PR and between 0082cce and ffd9b83.

📒 Files selected for processing (1)

README.md

Disabled knowledge base sources:

Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

📝 Walkthrough

Walkthrough

Updated README.md with an expanded contribution and setup guide. Replaced manual "Local Setup" instructions with comprehensive workflows including Docker Compose startup, pnpm installation, scoped database migrations, and new sections covering day-to-day commands, database helpers, E2E tests, workspace-engine operations, directory structure, and code-style guidelines.

Changes

Cohort / File(s)	Summary
Documentation `README.md`	Expanded setup and contribution guide with restructured workflow (docker → pnpm → migrations → dev), added sections for daily commands, database operations, E2E testing, workspace-engine instructions, monorepo structure, and code-style checklist.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

chore: fix relay build and improve dev setup #927: Modifies developer setup documentation in README/CLAUDE.md with updates to local dev workflow commands (pnpm/docker/migrations setup patterns).

Poem

🐰 Hops through the docs with glee so bright,
Setup instructions now crystal clear and tight,
Docker, pnpm, migrations flow—
Contributing's never been easier, don't you know? ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch claude/issue-913-20260409-1706

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.}

CLAassistant · 2026-04-09T17:09:09Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

Copilot

Pull request overview

Enhances the README’s contributing section to give contributors clearer local setup, common workflows, and repo orientation.

Changes:

Expanded prerequisites and first-time local setup steps (Docker, Flox/pnpm, DB migrations, dev servers).
Added day-to-day development commands plus dedicated DB and Playwright E2E guidance.
Documented monorepo structure, code style expectations, and a basic PR workflow checklist.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-09T17:11:15Z

README.md

+- [Docker](https://docs.docker.com/get-docker/) engine installed and running
+- [Flox](https://flox.dev/docs/install-flox/install/) installed (manages Node.js, pnpm, Go, and other tooling)
+- [pnpm](https://pnpm.io/installation) (if not using Flox)
+- [Go 1.22+](https://go.dev/dl/) (only needed if working on `workspace-engine` or `relay`)


The Go version requirement here looks out of date. apps/workspace-engine/go.mod specifies go 1.25.7 and apps/relay/go.mod specifies go 1.25.4, so Go 1.22+ will not be sufficient for contributors working on these apps. Please update the prerequisite to match the repository’s current minimum Go version (likely 1.25+).

Suggested change

- [Go 1.22+](https://go.dev/dl/) (only needed if working on `workspace-engine` or `relay`)

- [Go 1.25+](https://go.dev/dl/) (only needed if working on `workspace-engine` or `relay`)

Copilot · 2026-04-09T17:11:16Z

README.md

+```bash
+cd apps/workspace-engine
+go run ./...                          # Run without building
+go build -o ./bin/workspace-engine .  # Build binary
+go test ./...                         # Run tests


go run ./... will fail in this module because ./... expands to multiple packages including more than one package main (e.g., . and tools/seed). Use a single main package target (for example go run .) so the command works as written.

Copilot AI review requested due to automatic review settings April 9, 2026 17:08

adityachoudhari26 merged commit 155c921 into main Apr 9, 2026
7 of 8 checks passed

adityachoudhari26 deleted the claude/issue-913-20260409-1706 branch April 9, 2026 17:08

Copilot started reviewing on behalf of adityachoudhari26 April 9, 2026 17:09 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: enhance contributing section in README#952

docs: enhance contributing section in README#952
adityachoudhari26 merged 1 commit intomainfrom
claude/issue-913-20260409-1706

adityachoudhari26 commented Apr 9, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 9, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

Uh oh!

CLAassistant commented Apr 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 9, 2026

Uh oh!

Copilot AI Apr 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	- [Go 1.22+](https://go.dev/dl/) (only needed if working on `workspace-engine` or `relay`)
	- [Go 1.25+](https://go.dev/dl/) (only needed if working on `workspace-engine` or `relay`)

Conversation

adityachoudhari26 commented Apr 9, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

Uh oh!

CLAassistant commented Apr 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

adityachoudhari26 commented Apr 9, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 9, 2026 •

edited

Loading