mcpField
G
groove-utilities-onboard

groove-utilities-onboard

github.com/andreadellacorteAgent 工作流6505 次安装14 周前更新
代码仓库

关于 groove-utilities-onboard

为 Groove 项目生成定制化的 GROOVE.md,并可在已有的 CONTRIBUTING.md 中添加链接说明,帮助贡献者了解配置、命令和工作流要求。

主要功能

  1. 01读取 Groove 项目配置
  2. 02生成简明的 GROOVE.md
  3. 03可选更新已有 CONTRIBUTING.md
  4. 04填入任务与 Git 设置
  5. 05询问项目专属背景信息

适用场景

  1. 01为新贡献者记录 Groove 设置
  2. 02在贡献指南中补充 Groove 说明

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/andreadellacorte/groove --skill groove-utilities-onboard

安装后在 Claude Code 中输入/groove-utilities-onboard确认已加载。

详细介绍

groove-utilities-onboard

在项目根目录生成 GROOVE.md 文件,为加入使用 groove 的项目的贡献者提供简明的入门指南。如果存在 CONTRIBUTING.md,还可选择在其中追加 groove 部分。

预期结果

新贡献者了解 groove 在此项目中的工作方式:要运行哪些命令、日志存放在哪里,以及复合循环对他们有哪些要求。

验收标准

  • 项目根目录存在 GROOVE.md,其中的项目专属配置值已替换为实际值
  • 如果存在 CONTRIBUTING.md,其中包含一个指向 GROOVE.md 的 "## Using groove" 部分
  • 内容反映实际配置值(任务后端、Git 策略)

步骤

  1. 从 .groove/index.md 中读取 tasks.backend、memory.review_days、git.*;memory 始终为 .groove/memory/,specs 始终为 .groove/memory/specs/
  2. 询问:“是否有需要补充的项目专属背景信息?(例如要接手哪些任务、团队惯例)——按回车跳过”
  3. 使用下方模板编写 GROOVE.md,并替换为实时配置值
  4. 如果存在 CONTRIBUTING.md 且其中尚未包含 ``:
    • 追加以下部分:
      
      ## Using groove
      本项目使用 [groove](https://github.com/andreadellacorte/groove) 开展 AI 辅助工程工作流。有关设置和命令,请参阅 [GROOVE.md](./GROOVE.md)。
      
      
  5. 报告:“GROOVE.md 已写入”,并说明是否已更新 CONTRIBUTING.md

GROOVE.md 模板

# Groove Workflow

This project uses [groove](https://github.com/andreadellacorte/groove) — an AI-assisted engineering workflow companion.

## Quick start

```bash
npx skills add andreadellacorte/groove
/groove-admin-install

然后,每次会话都从以下内容开始:

/groove-utilities-prime

日常工作流

/groove-daily-start     — review yesterday, load tasks, set agenda
/groove-daily-end       — write memory, commit logs

复合循环(适用于任何功能或修复)

/groove-work-brainstorm — clarify scope
/groove-work-plan       — research and plan
/groove-work-exec       — implement
/groove-work-review     — evaluate output
/groove-work-compound   — capture lessons

配置

键值
任务后端<tasks.backend>
Memory 路径.groove/memory/
Specs 路径.groove/memory/specs/
Git 策略(memory)<git.memory>

惯例

  • 阶段任务的命名格式为 YYYY-MM-DD, <Stage> ——不使用数字
  • 标记任务完成前,必须先在任务正文中添加“变更摘要”
  • 归档始终由用户触发——绝不自动执行

文件位置

  • 配置:.groove/index.md
  • 每日日志:.groove/memory/daily/
  • 已学习的见解:.groove/memory/learned/
  • Specs:.groove/memory/specs/
  • Hooks:.groove/hooks/(start.md、end.md)
```

Constraints

  • Read .groove/index.md and substitute all placeholder values before writing
  • If GROOVE.md already exists: ask "GROOVE.md exists — overwrite, update, or skip?" before touching it
  • The <custom-context> block is replaced with user-provided context or removed if none
  • Do not create CONTRIBUTING.md if it doesn't exist — only append to existing files
  • GROOVE.md should be short enough to read in 2 minutes

评论

支持 Markdown