MA

mbeacom/adrkit

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

22 stars 6 forks 质量 67 趋势 30Apache-2.0

机器可读架构决策记录。Git原生决策内存和治理,适用于人工和代理编写的计划——lint、CI和MCP。

概览

—— 能够机器读取、在配置项中可执行、并且对代理来说可读的架构决策记录,无需离开 git。 大多数ADR工具是一个标记低模板和一个静态站点生成器。它记录了一个决策;它不让决策做任何事情。ADRKIT将记录视为一个字段——影响——以便工具回答“哪些决策控制这个拉取请求?”,并将答案放在下一个决策的位置。 一个80秒的导览,从终端到GitHub Copilot应用的拉取请求: https://github.com/user-attachments/assets/2ab466f9-53f0-4274-a87c-98d8d5e5ecdf 最后一幕的静态画面。选择它观看15秒的录像。 在拉取请求中,管理决策的Action会以评论形式发布该答案,GitHub Copilot代码审查可以引用记录,因为它存在于仓库中: MBEACOM/ADRKIT-demo 是一个小型支付账本仓库,开放这些拉取请求,管理 ARB 队列问题,并记录每个命令。

概述(AI 翻译)

人类和代理编写计划的决策记忆 — 架构决策 这些记录是机器可读的,在CI中可执行,且对代理人员可读, 而且不离开 GIT 系统。

大多数ADR工具都是markdown模板和静态网站生成器。那 记录一个决策;它并不让决定做任何事。adrkit处理的是 记录为带有标记降落正文的类型数据并添加一个字段 — affects — 所以工具可以回答*“哪些决策控制这个拉取请求?”* 并放置 回答下一步决策在哪里做出。

一个80秒的巡演,从终端到拉取请求再到GitHub Copilot 应用:

https://github.com/user-attachments/assets/2ab466f9-53f0-4274-a87c-98d8d5e5ecdf

最后一幕的静态画面。选择它观看15秒的录像。

在拉取请求中,治理决策 Action 该回答的帖子作为评论,GitHub Copilot代码审查可以引用记录 因为它存在于仓库中:

mbeacom/adrkit-demo 是小的 开启这些拉取请求的支付账本仓库,一个管理的ARB队列 问题,以及每个命令的录音。

决策治理,非生成文档

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

adrkit

Decision memory for human- and agent-authored plans — architecture decision records that are machine-readable, enforceable in CI, and legible to agents, without leaving git.

Most ADR tooling is a markdown template and a static site generator. That records a decision; it doesn’t make the decision do anything. adrkit treats a record as typed data with a markdown body and adds one field — affects — so a tool can answer “which decisions govern this pull request?” and put the answer where the next decision is being made.

An 80-second tour, from the terminal to the pull request to the GitHub Copilot app:

https://github.com/user-attachments/assets/2ab466f9-53f0-4274-a87c-98d8d5e5ecdf

A still of the final screen. Select it to watch the 15-second recording.

On a pull request, the governing-decisions Action posts that answer as a comment, and GitHub Copilot code review can cite a record because it lives in the repository:

mbeacom/adrkit-demo is a small payments-ledger repository with these pull requests open, a managed ARB queue issue, and recordings of every command.

Decision governance, not generated documentation

Generated knowledge systems answer “how does the system work now?” adrkit answers “what did people decide, what alternatives were rejected, and which decisions govern this change?” ADR-0037 sets that boundary: generated knowledge systems are downstream read models of adrkit’s human-reviewed decision corpus, never decision authorities.

在 GitHub 查看完整 README

安装

npx @adrkit/cli lint # validate the corpus in docs/adr
新手?先看 mcpskill.org 教程 →