# Github Comment

> 定义 GitHub 评论的格式规范, 强调使用折叠 `<details>` 保持简洁。

- Skill: `ctex-org/github-comment` (Agent Skill)
- Install (CLI): `npx skillmds@latest add ctex-org/github-comment`
- Raw SKILL.md: https://api.skillmd.com/api/skills/ctex-org/github-comment/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: ctex-org (https://skillmd.com/u/ctex-org)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/ctex-org/github-comment

---


# GitHub 评论规范 (所有 Skill 的基础)

此规范适用于所有在 GitHub Action 中运行的 Skill。

## 核心规则

1. **简体中文**: 所有输出必须使用简体中文。
2. **单条评论**: 在无头 (headless) 环境运行，所有输出合并为一条评论。
3. **折叠长内容**: 使用 `<details>` 折叠代码、日志、技术细节。`<details>` 前后需空行。
4. **先读 llmdoc**: 操作前必须阅读项目的 `llmdoc/` 文档。
5. **只生成正文**: Agent 不查询、发表、编辑或删除 GitHub 评论。完整正文通过结构化输出交给独立 publisher 代发。
6. **不重复评论**: publisher 使用 workflow 定义的稳定 marker 更新已有评论，Agent 不负责幂等控制。

## 链接格式

引用代码时使用完整格式，否则 Markdown 无法正确渲染：

```
https://github.com/{owner}/{repo}/blob/{full_sha}/{path}#L{start}-L{end}
```

- 必须使用完整 commit SHA，不能用 `$(git rev-parse HEAD)`
- 行号格式：`#L10-L15`，提供前后至少 1 行上下文

## 模板

```markdown
### 标题

简明扼要的核心信息。

<details>
<summary>详情</summary>

长篇内容、代码、日志等。

</details>
```