diff --git a/.cursorrules b/.cursorrules new file mode 100644 index 00000000..cc9445d1 --- /dev/null +++ b/.cursorrules @@ -0,0 +1,24 @@ +# OpenWork AI Contributor Rules + +## Project Context +- **Philosophy**: OpenWork is a premium, open-source "Claude Work" style system. +- **Reference**: Always review `AGENTS.md` and `MOTIVATIONS-PHILOSOPHY.md` for context on product goals. + +## Technology Stack +- **Dependencies**: Use `pnpm` exclusively. `npm` and `yarn` are forbidden. +- **Frontend**: SolidJS + TailwindCSS. +- **Desktop/Shell**: Tauri 2.x (Rust). + +## Development Workflow +1. **Verification**: Before submitting changes, run: + - `pnpm typecheck` + - `pnpm test:e2e` (or relevant subset) +2. **PRDs**: Create new Product Requirement Documents in `packages/app/pr/.md` observing `.opencode/skill/prd-conventions/SKILL.md`. + +## Coding Guidelines +- **UI Quality**: Prioritize a "premium feel" with smooth animations (60fps) and clear mobile-native layouts. +- **SolidJS Patterns**: Follow reactivity patterns in `.opencode/skill/solidjs-patterns/SKILL.md`. Avoid global `busy()` deadlocks; use scoped async state. +- **OpenCode Parity**: Ensure UI features map cleanly to OpenCode primitives or `opencode` CLI tools. + +## Release Process +- Use `pnpm bump:patch`, `pnpm bump:minor`, etc. to ensure version synchronization across `package.json`, `tauri.conf.json`, and `Cargo.toml`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..25477808 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing + +- Review `AGENTS.md` and `MOTIVATIONS-PHILOSOPHY.md` to understand the product goals before making changes. +- Ensure Node.js, `pnpm`, the Rust toolchain, and `opencode` are installed before working inside the repo. +- Run `pnpm install` once per checkout, then verify your change with `pnpm typecheck` plus `pnpm test:e2e` (or the targeted subset of scripts) before opening a PR. +- Add new PRDs to `packages/app/pr/.md` following the `.opencode/skill/prd-conventions/SKILL.md` conventions described in `AGENTS.md`. diff --git a/README.md b/README.md index 7c3c388f..0cdbc76b 100644 --- a/README.md +++ b/README.md @@ -147,10 +147,7 @@ pnpm test:e2e ## Contributing -- Review `AGENTS.md` and `MOTIVATIONS-PHILOSOPHY.md` to understand the product goals before making changes. -- Ensure Node.js, `pnpm`, the Rust toolchain, and `opencode` are installed before working inside the repo. -- Run `pnpm install` once per checkout, then verify your change with `pnpm typecheck` plus `pnpm test:e2e` (or the targeted subset of scripts) before opening a PR. -- Add new PRDs to `packages/app/pr/.md` following the `.opencode/skill/prd-conventions/SKILL.md` conventions described in `AGENTS.md`. +Please see [CONTRIBUTING.md](./CONTRIBUTING.md). ## License