-
Notifications
You must be signed in to change notification settings - Fork 20
docs: Refactor README, add CONTRIBUTING.md and LICENSE #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
UtkarshTheDev
wants to merge
7
commits into
joelhooks:main
Choose a base branch
from
UtkarshTheDev:docs/refactor-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+110
−81
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6b4e479
📚 docs: Clarify quick‑start steps and fix formatting
UtkarshTheDev 30311c6
📚 docs: Add header image to README and remove ASCII art
UtkarshTheDev d5ab4f3
📚 docs Add MIT license file to repository.
UtkarshTheDev 13fd8e6
📚 docs Add CONTRIBUTING.md to guide contributors
UtkarshTheDev 2e1dc98
📚 docs: Clean README: remove sections, link to CONTRIBUTING
UtkarshTheDev 837d695
📚 docs Update ADR links to markdown format
UtkarshTheDev def4270
📚 docs: Update README clone URL and formatting
UtkarshTheDev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Contributing to OpenCode Vibe | ||
|
|
||
| We focus on speed, precision, and type safety. We use **Bun** for everything. | ||
|
|
||
| ## Core Philosophy | ||
|
|
||
| 1. **Core Owns Computation**: Logic lives in `packages/core`. React only binds UI. | ||
| 2. **Push-Based State**: We use `createWorldStream()` via Effect/Atoms. | ||
| 3. **Type Safety First**: No `any`. No type assertions unless absolutely necessary. | ||
|
|
||
| ## Development Setup | ||
|
|
||
| **Prerequisites**: [Bun](https://bun.sh) v1.3+ | ||
|
|
||
| ```bash | ||
| # Install dependencies | ||
| bun install | ||
|
|
||
| # Start development server | ||
| bun dev | ||
| ``` | ||
|
|
||
| ## Workflow | ||
|
|
||
| ### 1. Make Changes | ||
| - Follow **TDD**: Write failing tests (Red) → Implement (Green) → Clean up (Refactor). | ||
| - Use **Vitest** for testing: `bun test`. | ||
|
|
||
| ### 2. Verify Quality | ||
| Before committing, you **MUST** pass all checks: | ||
|
|
||
| ```bash | ||
| bun format # Fix formatting (Biome) | ||
| bun lint # Check linting (oxlint) | ||
| bun run typecheck # Check types (Turbo) | ||
| ``` | ||
|
|
||
| > **Note**: `bun run typecheck` checks the entire monorepo. Do not skip this. | ||
|
|
||
| ### 3. Commit & PR | ||
| - We use **Changesets** for versioning. | ||
| - If your change affects published packages, run: | ||
| ```bash | ||
| bun changeset | ||
| ``` | ||
| - Follow the prompt to add a summary. | ||
|
|
||
| ## Monorepo Structure | ||
|
|
||
| - **`apps/web/`** - Next.js 16 web application (App Router, RSC, Tailwind) | ||
| - **`apps/swarm-cli/`** - CLI for visualizing world state across servers | ||
| - **`packages/core/`** - World stream, atoms, Effect services, types | ||
| - **`packages/react/`** - React bindings (hooks, providers, store) | ||
|
|
||
| ## Documentation | ||
|
|
||
| - **`apps/web/README.md`** - Web app architecture and patterns | ||
| - **`packages/core/README.md`** - Core SDK and world stream documentation | ||
| - **`packages/react/README.md`** - React hooks and providers | ||
| - **`docs/adr/`** - Architecture Decision Records | ||
| - [ADR-016: Core Layer Responsibility](docs/adr/016-core-layer-responsibility.md) (Core owns computation, React binds UI) | ||
| - [ADR-018: Reactive World Stream](docs/adr/018-reactive-world-stream.md) (`createWorldStream()` is THE API) | ||
| - **`docs/guides/`** - Implementation guides (SSE sync, mobile, subagents) | ||
| - **`AGENTS.md`** - AI agent conventions and development patterns | ||
|
|
||
| ## License | ||
|
|
||
| By contributing, you agree that your code will be licensed under the MIT License. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2026 OpenCode VIBE | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.