github / github/spec-kit

[Extension]: Update DocGuard — CDD Enforcement (v0.40.5)

未关闭 适合新手
#4,590 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
extension-submission triage-nice-to-have validation-passed
主要语言
Python
星标
137k
派生
12.3k
平均合并
2 天 12 小时
30 天内合并 PR
159

描述

### Extension ID

docguard

### Extension Name

DocGuard — CDD Enforcement

### Version

0.40.5

### Description

Documentation integrity for AI-assisted repositories: lifecycle registry, drift validation, traceability, safe archival, SARIF/JUnit, MCP, GitHub Actions, and Spec Kit hooks.

### Author

raccioly

### Repository URL

https://github.com/raccioly/docguard

### Download URL

https://github.com/raccioly/docguard/releases/download/v0.40.5/spec-kit-docguard-v0.40.5.zip

### License

MIT

### Homepage (optional)

https://www.npmjs.com/package/docguard-cli

### Documentation URL (optional)

https://github.com/raccioly/docguard/blob/main/extensions/spec-kit-docguard/README.md

### Changelog URL (optional)

https://github.com/raccioly/docguard/blob/main/CHANGELOG.md

### Required Spec Kit Version

>=0.1.0

### Required Tools (optional)

- node (>=18.0.0) - required
- npx - required
- specify - optional (auto-initializes the SDD workflow during docguard init)

### Number of Commands

12

### Number of Hooks (optional)

5

### Tags

documentation, validation, traceability, ai-agents, spec-kit

### Key Features

- Configurable quality gate with severity triage and a remediation plan
- AI-driven documentation repair with codebase research and validation loops
- Cross-document semantic consistency analysis (read-only review)
- CDD maturity score with an ROI-based improvement roadmap
- Reverse-engineers canonical docs from an existing codebase
- spec-kit workflow hooks (before_specify, after_implement, after_converge, before_tasks, after_tasks)

### Testing Checklist

- [x] Extension installs successfully via download URL
- [x] All commands execute without errors
- [x] Documentation is complete and accurate
- [x] No security vulnerabilities identified
- [x] Tested on at least one real project

### Submission Requirements

- [x] Valid `extension.yml` manifest included
- [x] README.md with installation and usage instructions
- [x] LICENSE file included
- [x] GitHub release created with version tag
- [x] All command files exist and are properly formatted
- [x] Extension ID follows naming conventions (lowercase-with-hyphens)

### Testing Details

The exact published ZIP was installed from the release URL into a freshly initialized disposable Spec Kit project with the current `specify` CLI. Installation completed without manifest errors, and `specify extension list` reported DocGuard v0.40.5 with **12 commands and 5 hooks**. The installed `extension.yml`, `commands/fix.md`, and `commands/review.md` are byte-for-byte identical to the tagged release sources; the command-contract suite also checks unique names, same-named routing, file existence, frontmatter, and complete declaration of every shipped command.

The exact release commit passed **1,794 tests on Node.js 18, 20, 22, and 24**, DocGuard's self-check, and the OSV supply-chain scan. The publication workflow successfully produced the GitHub release, npm and PyPI packages, GHCR image, extension ZIP, and MCPB artifact. Product behavior has also been exercised against the repository's pinned public-project benchmark corpus and prior cross-project field tests.

### Example Usage

```bash
# Install the extension
specify extension add docguard --from https://github.com/raccioly/docguard/releases/download/v0.40.5/spec-kit-docguard-v0.40.5.zip

# Run the documentation quality gate
/speckit.docguard.guard
```

### Proposed Catalog Entry

```json
{
"docguard": {
"name": "DocGuard \u2014 CDD Enforcement",
"id": "docguard",
"description": "Documentation integrity for AI-assisted repositories: lifecycle registry, drift validation, traceability, safe archival, SARIF/JUnit, MCP, GitHub Actions, and Spec Kit hooks.",
"author": "raccioly",
"version": "0.40.5",
"download_url": "https://github.com/raccioly/docguard/releases/download/v0.40.5/spec-kit-docguard-v0.40.5.zip",
"repository": "https://github.com/raccioly/docguard",
"homepage": "https://www.npmjs.com/package/docguard-cli",
"documentation": "https://github.com/raccioly/docguard/blob/main/extensions/spec-kit-docguard/README.md",
"changelog": "https://github.com/raccioly/docguard/blob/main/CHANGELOG.md",
"license": "MIT",
"requires": {
"speckit_version": ">=0.1.0",
"tools": [
{
"name": "node",
"version": ">=18.0.0",
"required": true
}
]
},
"provides": {
"commands": 12,
"hooks": 5
},
"tags": [
"documentation",
"validation",
"traceability",
"ai-agents",
"spec-kit"
],
"verified": false,
"downloads": 0,
"stars": 0
}
}
```

### Additional Context

**This updates the existing catalog entry (`docguard`)**. Please bump that entry to v0.40.5 and use the new download URL rather than adding a duplicate.

v0.40.5 corrects the Spec Kit manifest contract: all 12 shipped commands are declared exactly once, `fix` and `review` route to their matching command files, and the manifest description matches the proposed catalog entry while remaining below Spec Kit's 200-character limit.

- Release: https://github.com/raccioly/docguard/releases/tag/v0.40.5
- Release PR: https://github.com/raccioly/docguard/pull/394
- Manifest correction: https://github.com/raccioly/docguard/pull/392
- Release workflow: https://github.com/raccioly/docguard/actions/runs/34926468263

贡献指南

打开贡献指南

调研方向

Locate the existing docguard catalog entry and compare it with the proposed catalog entry in the issue. Update that entry to v0.40.5 and the new download URL, without adding a duplicate; confirm the manifest details, command and hook counts, and links match the submission.

由索引模型根据 Issue 内容生成。

评估

技术栈
nodejs
领域
documentation, tooling
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
活跃
描述清晰度
基本清楚
新手友好度
75/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。