github-format-standards

github-format-standards is a skill for Claude Code, Codex from hawkongz/github-format-standards. It costs 165 tokens per session (4,861 once invoked), scanned A, original, MIT.

A workflow for preparing a project for publication on GitHub, a website for hosting and sharing code. It reviews the project, fixes documentation and structure, creates common project files, and can create and push a repository.

In plain words
What is it for?
Use it to clean a project, organize its files, improve its README and Markdown, add files such as a license and contribution guide, initialize Git, create a GitHub repository, and add repository labels and descriptions.
Why use it?
It removes the need to check GitHub publishing requirements manually and helps prevent temporary files, secrets, unclear documentation, and inconsistent naming from entering the repository.

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/hawkongz/github-format-standards/zh-cn
Any agent
npx skills add hawkongz/github-format-standards --skill zh-cn
Clone the repo
git clone --depth 1 https://github.com/hawkongz/github-format-standards

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for github-format-standards

README.md
[![agentmods](https://agentmods.dev/badge/skills/hawkongz/github-format-standards/zh-cn.svg)](https://agentmods.dev/skills/hawkongz/github-format-standards/zh-cn)
Your own site
<a href="https://agentmods.dev/skills/hawkongz/github-format-standards/zh-cn"><img src="https://agentmods.dev/badge/skills/hawkongz/github-format-standards/zh-cn.svg" alt="Measured on agentmods" height="20"></a>
Per session 165 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 4,861 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00165 $0.04861
Opus 5 $0.00082 $0.02431
Sonnet 5 $0.00033 $0.00972
Haiku 4.5 $0.00016 $0.00486

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

Security

Grade A, and why

github-format-standards scanned grade A with 1 finding 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 4d ago.

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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

`mkdir -p ... && curl -o ... raw.githubusercontent.com/...`
zh-CN/SKILL.md · 289 lines

How it starts

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

GitHub 格式规范

当用户想把项目分享到 GitHub 时,运行完整流水线。直接动手,不要只念规则。

完整流水线(七个阶段)

阶段一:根目录审查

检查项目根目录是否整洁:

  • 红线:大文件(>1MB)、临时文件(*.tmp*.bak~*)、编译产物(dist/build/*.pyc)、敏感文件(.envcredentials.**.pem)、IDE 残留(.vscode/.idea/
  • 发现后:警告用户,加入 .gitignore
  • 确保 .gitignore 存在且至少覆盖:node_modules/__pycache__/*.pyc.env.DS_Storedist/build/、IDE 目录
根目录审查:
  ⚠  node_modules/ 存在 — 已加入 .gitignore
  ✓  无大文件、无密钥、无编译产物
  ✓  .gitignore 已创建,含 12 条规则

阶段二:文件命名与目录结构

命名规则

  • 全小写 + 连字符(my-project)或下划线(my_project),同一项目统一
  • 文件名/目录名禁止空格、禁止中文(多语言文档项目除外)
  • 脚本放 scripts/、示例放 examples/、文档放 docs/、测试放 tests/__tests__/、源码放 src/lib/
  • 发现问题直接改名/移动

标准结构

project/
├── src/           # 源码(或 lib/)
├── tests/         # 测试(或 __tests__/)
├── docs/          # 文档(可选,也可集中在 README)
├── scripts/       # 工具脚本
├── examples/      # 使用示例
├── README.md
├── LICENSE
├── .gitignore
└── CONTRIBUTING.md

小项目(单文件脚本)保持扁平结构即可,不要过度设计。

阶段三:文档检查与修复

逐文件检查所有 .md,直接改:

  • 标题:# 标题 不是 #标题,不跳级(######
  • 代码块:每个 ``` 都标注语言
  • 表格:分隔行加 :--- 对齐标记
  • 列表:符号统一(* 优先),子列表缩进 2 空格
  • 命令可执行:每条 shell 命令必须显式标注解释器(python script.py 而非 ./script.pybash script.sh 而非 ./script.sh;Windows 专用命令用 powershell ...)。读者不应猜测如何运行一条命令。
  • 链接:无裸 URL,图片有 alt 文本
  • 中英文空格:使用 GitHub 不是 使用GitHub支持 10 个 不是 支持10个
  • 专有名词:GitHub 不是 githubJavaScript 不是 Javascript
  • 文件末尾:恰好一个空行
  • 图片路径:相对路径或 CDN,禁止本地绝对路径
  • 禁止模糊/口语化表达:将「你懂的」「you know the drill」「just works」替换为精确说明。平台标注用规范的 macOS / Linux: 格式,不用「你懂的 😄」这类写法。

阶段四:生成缺失文件

  • LICENSE(必选):用户未指定则默认 MIT
  • .gitignore(必选):根据项目语言生成
  • AUTHORS.md(必选):标注创作者和重要贡献者。用户是主要作者;如果项目借助 Claude Code 协作完成,将 Claude 列为贡献者。格式:创作者姓名/GitHub 用户名、贡献者姓名、每人一句话说明角色。
  • CONTRIBUTING.md(推荐):多文件项目都应该有
  • SECURITY.md(推荐):安全漏洞报告说明
  • .github/ISSUE_TEMPLATE/:bug 报告 + 功能建议 + config.yml
  • .github/PULL_REQUEST_TEMPLATE.md:改动摘要、测试计划、截图区域

Read the full file on GitHub · 289 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 4d ago First seen · 289 lines · 165 tokens per session scan A ca6b06c354e2

Subscribe to this mod's changes

github-format-standards is a skill published in the GitHub repository hawkongz/github-format-standards (2 stars, last pushed 3mo ago), licensed MIT. It adds 165 tokens to every session and 4,861 once invoked, about $0.0008 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

format-markdown

Formats Markdown files consistently using project-native tooling first (repo scripts/config), then safe fallback formatters, and verifies the result with lint/check commands. Invoked when the user asks to format markdown, tidy docs, normalize README files, or fix markdown style drift.

soulcodex/agentic · 56 tokens

markdown-linter-fixer

Fix markdownlint errors in markdown files using markdownlint-cli2. Use when asked to "markdown linter fixer", "run markdownlint", "fix markdown lint errors", "fix MD029", or "resolve ordered list issues" across one or more .md files.

s2005/markdown-linter-fixer-skill · 60 tokens

README Generator

Create professional, comprehensive README files for any project.

GetSkill-Agent/getskill-skills · 12 tokens

decided-capture

Capture a NEW decision or requirement from a conversation (an interview) into ONE valid RAC (requirements-as-code) artifact — you interview and propose, the human ratifies, decided validate closes, and promotion into the trusted corpus is by pull request reviewed by someone other than the author. Use when a user wants…

asdecided/core · 113 tokens

decided-import

Reformat ONE existing document (a decision, requirement, design, roadmap, or prompt) into ONE valid RAC (requirements-as-code) artifact, with a mandatory human-review step before any file is written and decided validate as the deterministic close. Use when a user wants to add or import a single existing decision or…

asdecided/core · 98 tokens

decided-artifacts

Author and maintain RAC (requirements-as-code) Markdown artifacts — requirements, decisions, roadmaps, prompts, designs — using the decided CLI. Use when asked to create, read, validate, update, or link AsDecided (RAC) artifacts in a project's decisions/ directory.

asdecided/core · 62 tokens