Community写作与编辑github.com

ahmadrosid/nakama

用 ADHD 友好的可扫描格式编写或重写 GitHub PR 描述:结果优先、两行前后对比、简短安全理由列表、残余风险一句话、紧凑测试计划。适用于所有 Nakama PR 正文(代理和人类)。

nakama 是什么?

该技能强制要求 Nakama 仓库的 PR 描述采用高度结构化的按需格式,旨在让审阅者一眼就能掌握重点。其核心是“结果优先”的摘要行,后跟“之前/之后”两行对比、一个编号的“为什么安全”列表(最多 3 项)、以及一个残余风险或回滚触发条件。测试计划必须包含至少一个已运行且显示通过计数的命令,以及一个手动检查项。它明确禁止编写冗长的叙述性散文、文件变更旅游、以及嵌套标题;正文严格限制为 `## Summary` 和 `## Test plan` 两个顶级部分。提供一个“黄金示例”以说明预期的密度,并列出“反模式”,例如多段落摘要和模糊的“测试通过”声明。工作流包括读取 diff、构建模板,以及使用 `gh pr edit --body-file` 或 `gh pr create --body-file` 应用正文。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/ahmadrosid/nakama/tree/HEAD/.agents/skills/adhd-pr-description

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

预览

来自技能 README

Compound Engineering
HARNESS

文档

ADHD PR 描述

此仓库的默认 PR 正文格式。 审阅者应一眼就能看完描述。差异已经在 GitHub 上——不要复述文件移动。

代理:在撰写或重写 Nakama PR 描述(包括通过 ce-commit-push-pr)时加载此技能。正文形状来自此处;仍需从 diff 中收集实际声明(结果、风险、你验证的内容)。

形状(必填)

## 摘要

<一行:谁做了什么 → 结果。除非变更是行话,否则不要用行话遮罩。>

**之前:** <一行——旧行为或成本>
**之后:** <一行——新行为;如果有助于评估风险,请命名关键函数/路径>

为什么安全:
1. <理由>
2. <理由>
3. <理由>   <!-- 最多 2–3 项;如果没什么可说的就删掉 #3 -->

只有在 <一个残余风险或回滚触发条件> 时才重新添加/跟进。

## 测试计划
- [x] <已运行的命令>(<N> 项通过)
- [ ] <人类可在 <2 分钟 内完成的一项手动检查>

测试计划后可选内容(如果工作流需要 Compound Engineering 徽章则保留):

---

[![Compound Engineering](https://img.shields.io/badge/Built_with-Compound_Engineering-6366f1)](https://github.com/EveryInc/compound-engineering-plugin)
![HARNESS](https://img.shields.io/badge/<MODEL_SLUG>-000000)

规则

  1. 开头 = 结果。 第一行摘要描述新世界,而不是“此 PR 移除了…”。
  2. 之前/之后 = 两行。 加粗标签。不要用段落包裹它们。
  3. 为什么安全 = 编号,≤3。 正文中任意位置的总项目数限制为 5;如果更多,只保留那些改变决策的项目。
  4. 一个残余。 指出会让你撤销此更改的情况。如果真没有则跳过。
  5. 无差异旅游。 不要列出文件、行数作为故事,或“还清理了导出”,除非那就是风险。
  6. 测试计划 = 可执行。 优先使用包含通过计数的已勾选命令;一个未勾选的手动探测项。
  7. 标题保持常规。 type(scope): imperative — 简短。正文承载此形状;标题不需要表情符号或长文。
  8. 使用 gh 应用。 将正文写入临时文件;gh pr edit <n> --body-file … 或 gh pr create --body-file …。切勿使用 --body "$(cat …)"。

黄金示例

匹配此密度:

## 摘要

批准组织记忆提案 → 子弹点进入 `MEMORY.md`。无 LLM 调用。

**之前:** 确定性合并,然后可选的模型重写整个文件。
**之后:** 仅确定性合并(`applyApprovedOrgMemoryBullet`)。

为什么安全:
1. 去重 + 覆盖已存在于该函数中
2. LLM 路径已经失败并关闭到确定性结果
3. −230 行,相同的批准结果

只有在矛盾子弹点开始存活通过批准时,才重新添加 LLM 重写。

## 测试计划
- [x] `bun test packages/agent/src`(80 项通过)
- [x] `bun test apps/server/src/services/org-memory-service.test.ts`(15 项通过)
- [ ] 批准一个待处理的提案(已固定 + 最近日志)——子弹点与之前一样落地

反模式

不要做
多段落摘要一行结果 + 之前/之后 + 为什么安全
“此 PR 旨在…” / “为了…”以动词或用户操作开头
在摘要下嵌套 ###仅扁平 ## 摘要 + ## 测试计划
复述每个已删除文件仅残余风险
模糊的“测试通过”精确命令 + 通过计数

工作流

  1. 读取 PR diff / 提交(gh pr view, git diff base...HEAD)
  2. 命名:结果、之前、之后、≤3 条为什么安全、一个残余风险
  3. 填写模板——删除 diff 已证明的任何句子
  4. 通过 --body-file 应用
  5. 回复 PR URL(如果有用,加上“如果希望收紧标题请告知”仅当需要时)

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

相关技能