github

A writing guide for GitHub issues, pull requests, code reviews, and release notes in Zhin projects. GitHub is a service where teams track bugs, discuss changes, review code, and publish project updates.

In plain words
What is it for?
Use it to write issue reports, pull request descriptions, review comments, changelog entries, and test plans for Zhin projects.
Why use it?
It helps turn technical work and test results into clear text that teammates can review or paste into GitHub. It also keeps bug reports, change summaries, risks, and release notes structured.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/zhinjs/zhin/github
Any agent
npx skills add zhinjs/zhin --skill github
Clone the repo
git clone --depth 1 https://github.com/zhinjs/zhin

Made for: Claude Code, Codex.

Per session 58 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,028 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00058 $0.01028
Opus 5 $0.00029 $0.00514
Sonnet 5 $0.00012 $0.00206
Haiku 4.5 $0.00006 $0.00103

Measured yesterday against content hash dc7dfe7ffd17, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

github scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

packages/toolkit/create-zhin/template/skills/github/SKILL.md · 132 lines

How it starts

The opening of the file, as written. The whole thing — 132 lines — stays where its author put it; the contents beside it link to each section on GitHub.

GitHub

为 Zhin 生态仓库生成可直接粘贴的 GitHub 文案(Issue / PR / Review / Release),不代替 gh 执行发布。

何时使用

  • 写 Bug 报告、功能请求、PR 说明、Review 意见、版本发布说明
  • 需要把本地验证结果整理成「Test plan」
  • 不要用来改代码逻辑(除非用户明确要求附带补丁说明)

工作流

Issue

  1. 标题[area] 简短问题陈述(area 如 agent / adapter-icqq / cli
  2. 输出完整 Markdown(可直接贴 GitHub):
## 环境
- Node: v24.x
- zhin.js / @zhin.js/*: (版本或 commit)
- 适配器: icqq / telegram / ...
- OS: macOS / Linux

## 复现步骤
1. ...
2. ...

## 期望行为
...

## 实际行为
...

## 日志 / 截图
(脱敏;无 token)

Pull Request

  1. 输出完整 Markdown:
## Summary
- ...

## Test plan
- [x] `pnpm --filter @zhin.js/core test`
- [x] `pnpm type-check`
- [ ] `pnpm test`(如未跑则写原因)

## Risk
- Breaking: `zhin.config` `bots` → `endpoints`(如适用)
- DB: 自动迁移 `bot_id` → `endpoint_id`(如适用)

## Changeset
- [ ] 已添加 changeset(monorepo 发布包时必填)
  1. monorepo 常用验证命令(按改动范围选子集):
pnpm --filter <pkg> build
pnpm --filter <pkg> test
pnpm type-check
pnpm check:architecture   # 跨层改动时

Review

  • 按文件或主题分组
  • 区分 blocking vs nit
  • 给出具体修改建议,避免空泛「建议优化」

Release notes

  • 按 Keep a Changelog:Added / Changed / Fixed / Breaking
  • Breaking 必须写迁移步骤(如 bots:endpoints:

失败与兜底

触发条件 一线处理 仍失败
信息不足 列出缺失项(版本、配置、日志),🔴 暂停生成 用户补充后再写
含 token/密钥 删除敏感字段,用 <REDACTED> 占位 提醒用户轮换已泄漏凭证
gh 不可用 只输出 Markdown;给出 gh issue create / gh pr create 示例命令 用户手动在网页创建

🔴 CHECKPOINT · 敏感信息

生成前扫描:API token、.env 内容、私聊 ID、内网 URL。命中则不得写入 Issue/PR 正文。

不要做什么

  • 不要在 Issue/PR 里贴完整 zhin.config.yml 密钥
  • 不要编造未运行的测试结果为「已通过」
  • 不要把内部机器 hostname/IP 写进公开 issue
  • 不要用 PR 描述代替 Changeset(monorepo 发布流程)
  • 不要对非 Zhin 仓库套用 packages/im 分层术语

工具

用户要求代发时,在项目根用 gh(需已 gh auth login):

gh issue create --title "..." --body-file /tmp/issue.md
gh pr create --title "..." --body-file /tmp/pr.md

延伸阅读

文档 路径
贡献与 PR 流程 docs/agents/issue-tracker.md
Changeset 根目录 pnpm changeset
架构约束 AGENTS.md

Read the full file on GitHub · 132 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 132 lines · 58 tokens per session scan A dc7dfe7ffd17

Subscribe to this mod's changes

github is a skill published in the GitHub repository zhinjs/zhin (135 stars, last pushed 4d ago), licensed MIT. It adds 58 tokens to every session and 1,028 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

issue

Use when starting a chain from a GitHub issue — turning an issue URL or number into a triaged, planned, dispatched, and reviewed pull request. Classifies the thread (bug → root-cause discipline, feature → plan chain, question → drafted reply), synthesizes a spec from the issue's own acceptance criteria, then runs the…

jeremylongshore/tons-of-skills-marketplace · 115 tokens

wiki_submit

Submit wiki documentation pages to Wegent backend API. Simplifies the HTTP POST process for wiki content submission.

wecode-ai/Wegent · 21 tokens

pr-comment

Answer a maintainer's question about an open PR with concrete, code-cited evidence. The PR-side counterpart to issue-comment — for questions tied to the diff, not a full review.

nearform/lastlight · 41 tokens

github-api

Call the GitHub REST API from Fermi (issues, PRs, file commits, binary commits via Git Data API) with correct auth and UTF-8 handling.

abel30567/fermi-mcp · 36 tokens

github-cli

Automate GitHub workflows using the gh CLI for pull requests, issues, releases, actions, and repository management. Use when interacting with GitHub beyond basic git operations.

asgarovf/locusai · 37 tokens

changelog-orchestrator

Orchestrate 6-phase changelog generation workflow with AI synthesis, multi-source data fetching (GitHub/Slack/Git), quality validation, and automated PR creation. Use when automating release notes, weekly changelogs, or documentation updates. Trigger with "generate changelog", "weekly changelog", or "automate release…

jeremylongshore/plugins-nixtla · 75 tokens