Skip to content

Commit a206da8

Browse files
docs: add AGENTS.md with Cursor Cloud specific setup instructions (#559)
<!-- CURSOR_AGENT_PR_BODY_BEGIN --> Adds an `AGENTS.md` with a `## Cursor Cloud specific instructions` section documenting a non-obvious setup caveat for this Yarn Berry workspace monorepo. No production code changes. Discovered while setting up the dev environment (build, unit tests, and lint all pass): - `packages/protobufs/protos` and `packages/react-native-webrtc` are git submodules and must be initialized (`git submodule update --init --recursive`) before `yarn install`, otherwise install fails with `Workspace not found (@fishjam-cloud/react-native-webrtc@workspace:*)`. - Validated commands: `yarn build`, `yarn test:unit`, `yarn lint:check`. <!-- CURSOR_AGENT_PR_BODY_END --> <div><a href="https://cursor.com/agents/bc-0d2d55e2-cb0f-49b0-8d5f-15c80c2982c8"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a href="https://cursor.com/background-agent?bcId=bc-0d2d55e2-cb0f-49b0-8d5f-15c80c2982c8"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img alt="Open in Cursor" width="131" height="28" src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;</div> Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Piotr Wodecki <PiotrWodecki@users.noreply.github.com>
1 parent 9b4b404 commit a206da8

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# web-client-sdk
2+
3+
Fishjam web/client SDK — a Yarn (Berry, v4) workspace monorepo.
4+
5+
## Cursor Cloud specific instructions
6+
7+
Non-obvious setup caveat:
8+
9+
- `packages/protobufs/protos` and `packages/react-native-webrtc` are git submodules. They must be initialized before `yarn install`, otherwise install fails during resolution with `Workspace not found (@fishjam-cloud/react-native-webrtc@workspace:*)`. Run `git submodule update --init --recursive` first (the startup script does this).
10+
- Validated commands: `yarn build`, `yarn test:unit`, and `yarn lint:check` all pass. `yarn test:e2e` needs Playwright browsers and a running backend.

0 commit comments

Comments
 (0)