How to Contribute to Directories

This guide explains how to contribute new rules or prompts to the Cursor and Windsurf Directories.

Contribution Process:

1. Fork the Repo
2. Adding a New Rule:
   • Add your new rule in the packages/data/rules/index.ts file.
   • Create a new file (e.g., nextjs.ts) in packages/data/rules/.
   • Define prompts within the file, ensuring they are accurate, clear, actionable, and tested.
3. Adding New Prompts to Existing Rules:
   • Locate the relevant rule file in packages/data/rules/ (e.g., nextjs.ts).
   • Add new, tested prompts below existing ones.
4. Important Parameters in Rule Files:
   • tags: Language-specific tags (e.g., ["JavaScript", "Next.js"]).
   • title: Rule title (e.g., "Next.js Best Practices").
   • slug: Unique slug (e.g., "nextjs-best-practices").
   • content: Clear, actionable prompt content.
   • author: Contributor details (name, URL, avatar).
5. Create a PR

Getting Started:

npm install

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 in your browser.