Skip to content

add cursor rules #1405

@tyler-dane

Description

@tyler-dane

Priority

Medium (nice to have)

Feature Description

Create cursor rules files to help streamline code generation while using Cursor.

Include the following information, in addition to what is already in AGENTS.md

Naming Conventions
Hooks: camel-case. For example: useSupertokensAuth.ts and useSupertokensAuth.test.ts

Typescript: periods between works.

  • Good example: compass.event.parser.ts and compass.event.parser.test.ts
  • Bad example: onboardingStorage.util.ts. It should be onboarding.storage.util.ts

(+ the existing conventions listed in agents.md

Testing
If changed a file in packages/web, ensure all web tests pass before completion: yarn test web

If changed a file in packages/backend, ensure all backend tests pass before completion: yarn test backend

If changed a file in packages/core, ensure all core tests pass before completion: yarn test core

Use Case

This'll save Cursor users time by having the LLMs generate higher quality code

Additional Context

https://cursor.com/docs/context/rules#rule-folder-structure

Metadata

Metadata

Labels

devopsCI/CD, e2e tests, infra

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions