开发团队经常要做「贡献指南」这类事:为开源项目编写贡献指南。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。

本文介绍如何在 Windsurf Rules 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能贡献指南(contributing-guide)
作用为开源项目编写贡献指南
输入仓库与流程
输出CONTRIBUTING 文档
形态纯提示词
风险低
适用人群开发团队

处理流程分四步:

  1. 说明开发环境
  2. 写分支与提交规范
  3. 说明评审流程
  4. 附行为准则链接

这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。

在 Windsurf Rules 中是什么形态

Windsurf 的规则用于约束 Cascade 智能体的行为,工作区规则放在 .windsurf/rules/ 目录下,每条规则可以设置激活方式,例如始终生效、按文件匹配或由模型根据描述决定。

工作区规则随项目提交;全局规则只影响个人。激活方式的具体名称以 Windsurf 文档为准。

示例配置

.windsurf/rules/contributing-guide.md 示例(示意):

---
trigger: model_decision
description: 为开源项目编写贡献指南
---

# 贡献指南

1. 说明开发环境
2. 写分支与提交规范
3. 说明评审流程
4. 附行为准则链接

交付:CONTRIBUTING 文档。
- 改写历史、删除分支类操作只给建议,不直接执行。
- 信息不足时先提问,不要自行编造数据或事实。

示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发团队提出相关请求时能对上号;二是约束部分要写进「改写历史、删除分支类操作只给建议,不直接执行」这类领域规矩,避免智能体自作主张。

安装与启用步骤

  1. 新建 .windsurf/rules/contributing-guide.md
  2. 在头部设置激活方式与描述
  3. 正文写步骤、交付与边界
  4. 在 Cascade 中描述任务验证效果
  5. 提交到仓库

实操:一次完整的运行

假设你在Git 仓库与代码托管平台中发出这样的请求(虚构示例):

用贡献指南技能处理这份仓库与流程,输出CONTRIBUTING 文档。

智能体识别到任务与「贡献指南」相关后,会依次说明开发环境、写分支与提交规范、说明评审流程、附行为准则链接。最终交付CONTRIBUTING 文档,并在末尾列出需要人工确认的内容。你的工作是对照原始仓库与流程抽查两三处关键信息,确认无误后再使用。

测试与验收

分别用匹配与不匹配描述的请求测试,确认规则只在相关任务中被采用。

针对这个技能,还建议额外准备:

  • 一份信息齐全的标准仓库与流程,检查输出是否完整
  • 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效

常见坑

  • 所有规则都设为始终生效,浪费上下文。
  • 描述过于宽泛,模型在不相关任务中也套用。
  • 只写了步骤,没写交付格式,导致每次输出的CONTRIBUTING 文档结构不同。
  • 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。