Skip to content

Latest commit

 

History

47 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

cursor-setting

集中维护 Cursor 用户级 rules 与 skills 的仓库。先在本仓库改规则/技能、评审合并,再同步到本机 ~/.cursor/,避免直接改本机配置导致丢失或与团队约定不一致。

仓库:kne-union/cursor-setting

目录结构

cursor-setting/
├── rules/                 # 用户级 Cursor Rules(.mdc)
│   ├── development-workflow.mdc
│   ├── business-development-workflow.mdc
│   ├── worklog-write.mdc
│   ├── experience-distill-write.mdc
│   ├── experience-similar-search.mdc
│   ├── kne-document-remote-storage.mdc
│   ├── kne-document-search.mdc
│   ├── project-prompts-compliance.mdc
│   ├── prompts-update-workflow.mdc
│   ├── no-restart-user-services.mdc
│   └── responsive-utils-mobile.mdc
├── skills/                # 用户级 Cursor Skills(各子目录含 SKILL.md)
│   ├── weekly-report/
│   │   └── SKILL.md
│   └── qa-regression-report/
│       └── SKILL.md
└── README.md

本机还可能有仅存在于 ~/.cursor/rules/ 的规则(如 cursor-setting-first),未进本仓库的不要当作本仓源文件随意覆盖。
不要把本仓库 skills 同步到 ~/.cursor/skills-cursor/(该目录为 Cursor 内置技能)。

Rules 一览

文件 作用 生效范围
development-workflow.mdc 改代码:有 WIP 则 stash → 建分支 → 开发 → 验收 → 升版本/提交 → Push/PR → 还原 stash;结束后输出 DEVELOPMENT_COMPLETE 仅 remote 为 kne-union/* 的仓库
business-development-workflow.mdc 改代码:原仓有 WIP 则 stash → 拷到 ~/.cursor_workplace → 立刻还原;验收后副本提交 → 原仓再 stash → 同名分支拷回并 merge 个人基线 → 立刻还原;输出 DEVELOPMENT_COMPLETE 非 kne-union 的业务仓库
worklog-write.mdc 收到 DEVELOPMENT_COMPLETE 后写入工作日志 → MCP/REST 同步 remote → 输出 WORKLOG_WRITTEN 全局(靠信号门禁)
experience-distill-write.mdc 收到 WORKLOG_WRITTEN 后提炼经验卡 → MCP/REST 同步 remote(价值门槛;business/library/process) 全局(靠信号门禁)
experience-similar-search.mdc 动手前分层检索 experience/business、library 与 process 全局
kne-document-remote-storage.mdc worklog/experience 本地落盘后 MCP upload_* 优先同步 + sync-registry.json 全局
kne-document-search.mdc 查 @kne/* / remote 组件文档:优先 MCP search_document_index(必要时 fetch_docs);本地 npm-tools 索引仅兜底 涉及 KNE 文档时
project-prompts-compliance.mdc 项目有 prompts/ 时先读并按规范编写文档 / 示例;禁止擅自跑 build:docs、写 docs/ / dist 示例产物等 全局(有 prompts 时强制)
prompts-update-workflow.mdc 更新 prompts:先在当前项目本地 md 草稿让用户确认;拒绝则还原,同意再改 @kne/prompts-* 源仓 PR 发版 全局(更新 prompts 时强制)
responsive-utils-mobile.mdc 移动端适配统一用 @kne/responsive-utils 全局(KNE 前端)
no-restart-user-services.mdc 禁止擅自重启用户本地开发服务 全局

Skills 一览

目录 作用 触发场景
skills/weekly-report/ 用 MCP search_worklog 按时间/创建人拉日志并整理周报 写周报、本周/上周周报、weekly report
skills/qa-regression-report/ 用 MCP search_worklog 按今天/本周/本次迭代(git 相对已上线主干)+ 当前项目拉全员日志,整理给测试的功能回归报告 回归报告、功能回归、给测试的报告、本次迭代回归

同步到本机:~/.cursor/skills/<skill-name>/(整目录复制,含 SKILL.md)。

信号链(kne-union / 业务项目开发收尾):

development-workflow(PR 成功)
  或 business-development-workflow(原仓个人基线 merge 成功)
  → DEVELOPMENT_COMPLETE
  → worklog-write → 本地 worklog + MCP upload_worklog(或 REST 兜底)→ WORKLOG_WRITTEN
  → experience-distill-write → 本地 experience + MCP upload_experience(或 REST 兜底;低价值 skipped)

远程同步细则见 kne-document-remote-storage(MCP 路径不含 worklog/ / experience/ 前缀;registry 含前缀)。

路径均相对 ~/.kne_document/(禁止在 JSON/信号中存绝对路径)。业务项目的 workplace 副本在 ~/.cursor_workplace/,不进本仓库。

使用方法

1. 克隆

git clone https://github.com/kne-union/cursor-setting.git
cd cursor-setting

2. 同步到本机 Cursor(确认后再做)

Rules — 复制到用户级 rules 目录(按需覆盖):

# 仅同步本仓库维护的规则文件
cp rules/*.mdc ~/.cursor/rules/

同步后可删除本机已废弃的 experience-summary-write.mdc(若仍存在)。

或指定单个文件:

cp rules/development-workflow.mdc ~/.cursor/rules/

Skills — 整目录复制到用户级 skills(不是 skills-cursor):

mkdir -p ~/.cursor/skills
# 同步单个技能
cp -R skills/weekly-report ~/.cursor/skills/
# 或同步本仓库全部技能
cp -R skills/* ~/.cursor/skills/

同步后新开 Cursor Agent 会话,确认 Rules / Skills 已加载。

约定:

  1. 先在本仓库改 rules/*.mdc 或 skills/*/SKILL.md 并走 PR
  2. 合并且你明确确认后,再同步到 ~/.cursor/rules/ 或 ~/.cursor/skills/
  3. 不要把本机当作唯一源;不要未确认就批量覆盖本机其它无关配置;不要写入 ~/.cursor/skills-cursor/

3. 新增 / 修改规则

  1. 有未提交改动则 git stash push -u 后再从 master 拉分支:cursor/<简短英文描述>
  2. 在 rules/ 下新增或编辑 .mdc(YAML frontmatter + Markdown 正文)
  3. 本地看一眼描述与 alwaysApply / 适用范围是否正确
  4. 提交、开 PR;合并后按上一节同步本机

.mdc 最小结构:

---
description: 一句话说明,便于规则选择器展示
alwaysApply: true
---

# 标题

规则正文…

仅对特定文件生效时可用 globs,并设 alwaysApply: false。

4. 新增 / 修改 Skills

  1. 从 master 拉分支:cursor/<简短英文描述>
  2. 在 skills/<skill-name>/ 下写 SKILL.md(YAML frontmatter:name + description;正文为步骤)
  3. name 仅小写字母/数字/连字符;description 写清 WHAT + WHEN(第三人称,含触发词)
  4. 需要 agent 在「写周报」等场景自动选用时:不要设 disable-model-invocation: true
  5. 提交、开 PR;合并并确认后同步到 ~/.cursor/skills/<skill-name>/

5. 相关本机路径(规则/技能会读写,但文件不在本仓库)

路径 用途
~/.cursor/rules/ Cursor 用户级 rules 生效目录
~/.cursor/skills/ Cursor 用户级 skills 生效目录(本仓库 skills/ 同步目标)
~/.cursor/skills-cursor/ Cursor 内置 skills,勿用本仓库覆盖
~/.cursor_workplace/{项目}/{时间戳}/ 业务项目开发用副本(见 business-development-workflow)
~/.kne_document/worklog/ 会话工作日志
~/.kne_document/experience/business/ 项目业务经验卡
~/.kne_document/experience/library/ 组件/库用法与场景经验卡
~/.kne_document/experience/process/ 发版 / PR / CI 等交付流程经验卡
~/.kne_document/config.json developer-document MCP/REST 连接与 token
~/.kne_document/sync-registry.json 已同步到 remote 的 worklog/experience 登记
~/.kne_document_indexed/ @kne / remote 文档本地索引(kne-document-search 仅在 MCP 不可用时兜底)

与项目级规则的区别

类型 位置 适用
用户级 rules(本仓库) rules/ → ~/.cursor/rules/ 所有打开的项目(再由各规则自行限定范围)
用户级 skills(本仓库) skills/ → ~/.cursor/skills/ 所有打开的项目(按 description 触发)
项目级 各业务仓 .cursor/rules/ 或 .cursor/skills/ 仅该仓库

单仓库专用约定请写在业务仓项目级 rules/skills,不必放进本仓。

许可证

与 kne-union 组织约定一致;未单独声明时仅供组织内使用。

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors