GitHub
blog

向 CursorRules.org 添加新光标规则

了解如何向 CursorRules.org 添加新的光标规则,确保规则有效且格式正确,提升您的开发体验。

向 CursorRules.org 添加新光标规则

按照以下步骤向 CursorRules.org 添加新的光标规则。

第一步:添加新光标规则

  1. 打开 CursorRules 仓库: CursorRules
  2. 打开对应的 JSONC 文件 /data/json/[locale]/rules/{category}.jsonc
  3. 在文件中插入新的光标规则
  4. 如果 {category}.jsonc 文件不存在,请按以下步骤操作:
    1. /data/json/[locale]/rules/category.jsonc 中添加新分类
    2. /data/json/[locale]/rules/example.jsonc 复制到新位置 /data/json/[locale]/rules/{category}.jsonc
    3. 在新创建的文件中添加光标规则

第二步:提交更改并创建拉取请求

PR 检查清单

提交 PR 前,请确保完成以下事项:

  • [ ] 名称:提供描述所添加规则的简短标题
  • [ ] 描述:清晰说明添加了哪些规则以及所属分类
  • [ ] URL:提供规则的来源链接(如果有)
  • [ ] 数据排序:确保修改后的 JSON 文件中的所有数据按字母顺序排序
  • [ ] 规则验证:确认规则有效且在主流编辑器中可用
  • [ ] 相关性:确保仅包含与光标操作相关的规则

重要注意事项:

  1. 确保所有条目按字母顺序排序,因为它们将以此顺序在网站上显示
  2. 规则必须经过验证并在主流编辑器中可用
  3. 不要提交与光标操作无关的规则