Skip to content

docs: improve contributing guidelines and add .cursorrules #215

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.

Sign up for GitHub

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
RuturajS wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: improve contributing guidelines and add .cursorrules #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .cursorrules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/<name>.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`.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/<name>.md` following the `.opencode/skill/prd-conventions/SKILL.md` conventions described in `AGENTS.md`.
5 changes: 1 addition & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<name>.md` following the `.opencode/skill/prd-conventions/SKILL.md` conventions described in `AGENTS.md`.
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

Expand Down