docs: Refactor README, add CONTRIBUTING.md and LICENSE #12
Conversation
📝 WalkthroughWalkthroughAdds or updates three root documentation files: a new CONTRIBUTING.md with development guidelines and monorepo details, a new LICENSE file containing the MIT license, and a substantially rewritten README.md that condenses quick start instructions and points to CONTRIBUTING.md for full developer guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
🧰 Additional context used🧠 Learnings (12)📚 Learning: 2025-12-31T02:32:55.121ZApplied to files:
📚 Learning: 2025-12-29T07:19:12.483ZApplied to files:
📚 Learning: 2025-12-31T02:32:55.121ZApplied to files:
📚 Learning: 2025-12-31T02:32:55.121ZApplied to files:
📚 Learning: 2025-12-29T07:19:12.483ZApplied to files:
📚 Learning: 2025-12-29T07:19:12.483ZApplied to files:
📚 Learning: 2025-12-29T07:19:12.483ZApplied to files:
📚 Learning: 2025-12-31T02:32:55.121ZApplied to files:
📚 Learning: 2025-12-29T07:19:12.483ZApplied to files:
📚 Learning: 2025-12-31T02:32:55.121ZApplied to files:
📚 Learning: 2025-12-29T07:19:12.483ZApplied to files:
📚 Learning: 2025-12-29T07:19:12.483ZApplied to files:
🔇 Additional comments (3)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
demo/header.pngis excluded by!**/*.png
📒 Files selected for processing (3)
CONTRIBUTING.mdLICENSEREADME.md
🧰 Additional context used
🧠 Learnings (12)
📚 Learning: 2025-12-31T02:32:55.121Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-31T02:32:55.121Z
Learning: Applies to apps/web/app/**/*.{ts,tsx} : Use Next.js 16 App Router for page files (not Pages Router). Place pages in app/ directory with layout.tsx, page.tsx, and dynamic route segments like [id]/page.tsx.
Applied to files:
README.md
📚 Learning: 2025-12-29T07:19:12.483Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T07:19:12.483Z
Learning: Applies to **/*.{ts,tsx,js,jsx} : Use `Bun.serve()` with WebSockets, HTTPS, and routes support instead of `express`
Applied to files:
README.md
📚 Learning: 2025-12-31T02:32:55.121Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-31T02:32:55.121Z
Learning: Applies to apps/web/src/react/**/*.{ts,tsx} : Use SSE (Server-Sent Events) with `for await` loops for real-time sync. Integrate with Server Actions to dispatch events to Zustand store. Ensure 30s heartbeat to prevent WKWebView 60s timeout on mobile Safari.
Applied to files:
README.md
📚 Learning: 2025-12-31T02:32:55.121Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-31T02:32:55.121Z
Learning: Use Bun instead of Node.js, npm, pnpm, or vite. Use `bun <file>` instead of `node <file>`, `bun install` instead of npm/pnpm install, `bun build` instead of webpack/vite, and `bunx <package>` instead of npx.
Applied to files:
README.md
📚 Learning: 2025-12-29T07:19:12.483Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T07:19:12.483Z
Learning: Applies to **/*.ts : Run TypeScript files with `bun --hot <file.ts>` for hot module reloading during development
Applied to files:
README.md
📚 Learning: 2025-12-29T07:19:12.483Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T07:19:12.483Z
Learning: Applies to **/*.{ts,tsx,js,jsx,html,css} : Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild` for bundling
Applied to files:
README.md
📚 Learning: 2025-12-29T07:19:12.483Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T07:19:12.483Z
Learning: Applies to **/*.{ts,tsx,js,jsx} : Use `bunx <package> <command>` instead of `npx <package> <command>`
Applied to files:
README.md
📚 Learning: 2025-12-31T02:32:55.121Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-31T02:32:55.121Z
Learning: Always run typecheck via turbo from repo root to check the full monorepo. Do not run type-check in individual packages (e.g., cd apps/web && bun run type-check) as changes in one package can break types in another.
Applied to files:
README.md
📚 Learning: 2025-12-29T07:19:12.483Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T07:19:12.483Z
Learning: Applies to **/*.test.ts : Use `bun test` instead of `jest` or `vitest` for running tests
Applied to files:
README.md
📚 Learning: 2025-12-31T02:32:55.121Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-31T02:32:55.121Z
Learning: Applies to **/*.test.{ts,tsx} : Always use `bun run test` with Vitest, never `bun test` directly. The bun test command uses Bun's built-in test runner which has poor isolation causing state leakage between tests. Vitest with pool='forks' provides proper process isolation.
Applied to files:
README.md
📚 Learning: 2025-12-29T07:19:12.483Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T07:19:12.483Z
Learning: Applies to **/*.ts : Use `bun <file>` instead of `node <file>` or `ts-node <file>`
Applied to files:
README.md
📚 Learning: 2025-12-29T07:19:12.483Z
Learnt from: CR
Repo: joelhooks/opencode-vibe PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T07:19:12.483Z
Learning: Applies to package.json : Use `bun run <script>` instead of `npm run <script>`, `yarn run <script>`, or `pnpm run <script>`
Applied to files:
README.md
🪛 markdownlint-cli2 (0.18.1)
README.md
28-28: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (5)
CONTRIBUTING.md (1)
1-21: LGTM!Well-structured contributor guide with clear development setup and prerequisites. The Bun v1.3+ requirement and development commands align with the project's stack. The emphasis on running
bun run typecheckfrom the monorepo root (Line 38) is especially helpful for avoiding isolation issues.LICENSE (1)
1-21: Standard MIT License properly formatted.Copyright year 2026 and entity name "OpenCode VIBE" are correct. License text follows the standard MIT template without issues.
README.md (3)
32-57: Features and Tech Stack sections are clear and accurate.The features list clearly communicates the project's key capabilities, and the tech stack table is well-formatted with appropriate justifications. The emphasis on Bun as the runtime aligns with the project's documented workflow.
61-67: Contributing and License sections properly reference new files.The references to
CONTRIBUTING.mdandLICENSEare correctly formatted as relative markdown links. The README now appropriately delegates detailed development guidance to the new CONTRIBUTING.md while maintaining focus on quick-start and features.
1-1: The header image file atdemo/header.pngexists and is correctly referenced in the README.
|
Sir @joelhooks, Pls review this PR and merge it
|
1 participant
Summary
This PR overhauls the project documentation to be more professional, concise, and developer-friendly. It separates usage instructions from contribution guidelines and ensures standard files are present.
Changes
header.pngfor a polished look.bun format,bun lint,bun run typecheck).Verification
README.mdrenders correctly with the new header and simplified steps.CONTRIBUTING.mdcontains all necessary dev commands and links.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.