Community寫作與編輯github.com

ahmadrosid/nakama

以 ADHD 友善、易於掃讀的格式撰寫或改寫 GitHub PR 描述:結果優先、兩行前後對比、簡短安全理由、殘留風險一行、精簡測試計劃。Nakama 儲存庫所有 PR 主體(代理與人類)的預設格式。

nakama 是什麼?

此技能強制 Nakama 儲存庫的 GitHub PR 描述採用高度結構化、掃讀友善的格式,特別為 ADHD 開發者設計。它要求 PR 描述以結果為核心(第一行總結新的世界狀態,而非描述變更),並強制執行「Before/After」兩行對比、編號的安全理由列表(最多三項)、以及一項殘留風險或回滾觸發條件。底層遵循嚴格規則:避免「差異遊覽」(不逐項列出檔案),測試計劃必須包含可執行的命令與通過次數,並透過 `gh pr edit --body-file` 或 `gh pr create --body-file` 套用。此格式取代傳統的敘述性 PR 主體,透過強制一致、高密度的結構,大幅減少審查者的認知負擔。

相容平台~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)載入此技能。主體形狀由此提供;仍需從差異中收集真實聲明(結果、風險、你驗證的內容)。

形狀(必填)

## 摘要

<一行:誰做了什麼 → 結果。除非變更本身就是術語,否則避免術語迷霧。>

**Before:** <一行 — 舊行為或成本>
**After:** <一行 — 新行為;如有助於風險評估,請指名關鍵函式/路徑>

為什麼安全:
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. Before/After = 兩行。 粗體標籤。不用段落包裹它們。
  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 呼叫。

**Before:** 確定性合併,然後可選的模型重寫整個檔案。
**After:** 僅確定性合併(`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 次通過)
- [ ] 核准一個待決提案(釘選 + 最近日誌)— 子彈如之前般落地

反模式

不要這樣做請這樣做
多段落摘要一行結果 + Before/After + 為什麼安全
「此 PR 旨在…」/「為了…」以動詞或用戶動作開頭
在 Summary 下巢狀 ###僅扁平 ## 摘要 + ## 測試計劃
重複每個已刪除的檔案僅殘留風險
模糊的「測試通過」確切命令 + 通過次數

工作流程

  1. 閱讀 PR 差異 / 提交記錄(gh pr view、git diff base...HEAD)
  2. 命名:結果、before、after、≤3 為什麼安全、一個殘留風險
  3. 填寫模板 — 刪除差異已證明的任何句子
  4. 透過 --body-file 套用
  5. 回覆 PR URL(加上「若需要調整標題請告知」僅在有用時)

Individual skills in this repo

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

相關技能