如何为 Cursor AI 做出贡献
本指南将帮助您了解如何向 Cursor AI 目录添加新规则或提示。
1. 分叉存储库
2. 添加新规则
如果要提交 Cursor 目录中尚不存在的新规则,请执行以下步骤:
-
找到 Rule Index:
在文件中添加您的新规则。例如:
src/data/index.ts
import { cRules } from "./rules/c";
-
创建规则文件:
在目录中创建一个具有适当名称的新文件。例如,如果要为 Next.js 添加规则,请将文件命名为 .
src/data/rules/
nextjs.ts
-
定义规则:
在新创建的文件中添加提示。有关格式指南,请参阅现有规则。确保您的提示准确、清晰且对开发人员有帮助。
您的提示应该:
- 准确并与规则相关。
- 措辞清晰,以帮助开发人员轻松理解和使用它们。
- 具有可操作性,提供解决常见问题或优化工作流程的步骤或见解。
- 测试您的 Prompts:在提交之前,请确保您的 Prompt 已经过测试并在相关开发环境中按预期工作。这可确保其他开发人员可以依赖您在 🙂 的贡献。
3. 向现有规则添加新的提示/内容
如果要向现有规则添加新提示,请执行以下步骤:
-
查找现有规则:
导航到目录并打开要更新的规则的相关文件。例如,如果要添加 Next.js 提示,请打开 .
src/data/rules/
nextjs.ts
-
添加新提示:
在现有提示下方添加新提示。确保您的添加内容已经过测试。
4. 规则文件中的重要参数
创建或更新规则时,请务必包含以下参数,以确保一致性和清晰度:
-
tags:添加特定于语言的标签以对规则进行分类。
tags: ["JavaScript", "Next.js"]
-
title:提供描述规则的相应标题。
title: "Next.js Best Practices"
-
slug:创建反映规则用途的唯一 slug。
slug: "nextjs-best-practices"
-
content:在此处编写提示的内容。确保它清晰、可操作且对开发人员有帮助。简洁,但提供足够的细节来帮助光标 AI 有效地完成任务……
content: `your amazing prompt`
-
author:包括有关您作为贡献者的详细信息。这有助于其他人识别您的贡献,并允许他们在需要时伸出援手。
- name:您的全名或 GitHub 用户名。
- URL:指向您的 GitHub、Twitter、网站或您要共享的任何其他个人资料的链接。这是可选的,但建议这样做。
- avatar:代表您的图像或头像的 URL 路径。您可以使用来自 Gravatar 等服务或任何图像托管服务的照片。
5. 创建 PR
开始
首先,运行开发服务器:
npm install
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
使用浏览器打开 http://localhost:3000 以查看结果。
6. 如何在项目中使用光标规则。
- 首先,在项目的根目录中创建一个文件。
.cursorrules
- 导航到 Cursor 目录并复制相关规则。
- 将这些规则粘贴到文件中。
.cursorrules
- 使用 Cursor AI 编辑器(在聊天框或编辑器中)时,请通知 AI “遵循光标规则”,以确保提示与您在文件中定义的规则一致。AI 将生成符合自定义规则中设置的准则的输出。
.cursorrules
数据统计
数据评估
关于cursor.directory特别声明
本站哆咪虾提供的cursor.directory都来源于网络,不保证外部链接的准确性和完整性,同时,对于该外部链接的指向,不由哆咪虾实际控制,在2024-11-25 下午10:05收录时,该网页上的内容,都属于合规合法,后期网页的内容如出现违规,可以直接联系网站管理员进行删除,哆咪虾不承担任何责任。
相关导航
cursor是一个集成了GPT4、Claude 3.5等先进LLM的类vscode的编译器,可以理解为在vscode中集成了AI辅助编程助手
天工智码
AI智能编程助手,轻松生成各种代码
Deco
京东推出的设计稿一键生成多端代码工具
ChatDev
面壁智能推出的AI智能体软件开发平台,使用自然语言即可创建软件
Augment
AI编程辅助工具,专为大型代码库设计,Augment your codebase, your dev team, your company
CodeRabbit
AI驱动的代码审查平台,AI-first pull request reviewer with context-aware feedback, line-by-line code suggestions, and real-time chat.
PromptHero
PromptHero 是人工智能和提示工程领域的顶级网站。
Solo
Mozilla推出的零编程无代码AI网站建设工具,Solo uses AI to instantly create a beautiful website for your business
暂无评论...