Repository navigation
Releases: MicTx/readme-skill
Release list
v0.3.1
social preview 从强制检查项降为可选装饰项:未设置不再判问题,官方格式约束仅在设置时适用。
🔧 规则调整
- SKILL.md 硬性规则行:明确 social preview 是可选装饰(T0 范本 6/10 设置,未设时 GitHub 自动生成默认卡);PNG/JPG/GIF < 1 MB、≥ 640×320(最佳 1280×640)等官方限制只在决定上传时适用。
- 审查清单 E4:「social preview 已设」改为「可选,未设不判问题」——已设才核规格,og:image 域名二分验证法保留。
- facade-decor §三:开篇声明可选装饰项定位,审查不判问题、不扣分。
- audit.py:
SOCIAL_PREVIEW_DEFAULT保持 hint 级(不影响退出码),文案标注「可选装饰非强制」。
🇬🇧 Changelog
The skill no longer treats a missing social preview as a failed check. SKILL.md, checklist item E4, and facade-decor section 3 now mark it an optional decoration (6/10 T0 samples set one; GitHub renders a default card otherwise), with official format limits applying only when an image is uploaded; audit.py keeps its hint but labels it explicitly non-mandatory.
Full Changelog: v0.3.0...v0.3.1
v0.3.0
门面策略翻转:中文为主双语文档与 About 进入 skill 本体;README 按「读者可自证」的写法全面打磨,新增 30 秒自审示例。
🚀 亮点
- 中文为主双语策略进 skill 本体:SKILL.md 新增双语策略二选一(中文为主 / 英文为主),
audit.py描述预算区分 ASCII 120 与双语 200 字符;本仓库门面同步翻转为 README.md(中文主)+ README.en.md,About 改为中文主句(English gloss)。 - README 可自证的尝鲜示例:新增「30 秒尝鲜」一节——
python3 scripts/audit.py README.md直接审计本仓库自己,README 内嵌真实收敛输出,装好后复跑应逐字一致。 - 范本表纠错与实测:仓库名修正(
facebook/react、lobehub/lobe-chat)并链接化,星数于 2026-10-04 经 GitHub API 实测刷新;Release 徽章改为动态 shields。
📚 文档与门面
- README 新增目录(TOC)与「深入阅读」路由表(想做什么 → 去哪里),文件树退役。
- 首段一句话简介与线上 About 保持三处同构(逐字节一致)。
- 项目定名 readme-skill(SEO 优先命名),安装 URL 同步。
🇬🇧 Changelog
The facade flips to Chinese-primary bilingual: SKILL.md gains a two-mode bilingual strategy and audit.py budgets 120 ASCII / 200 bilingual characters for descriptions; this repo ships a zh-primary README with an interlinked README.en.md and a zh-lead About. The README gains a TOC, a read-deeper routing table, and a 30-second self-audit taste with real converged output; the sample table is corrected (facebook/react, lobehub/lobe-chat) with stars re-measured on 2026-10-04, plus a dynamic release badge.
Full Changelog: v0.2.0...v0.3.0
v0.2.0
Coverage grows from README/About/topics to the whole repository facade — and this repo now practices its own standard.
🚀 Highlights
- 82 new rules from a second distillation pass over the 12 samples — badges and the hero first screen, social preview cards, community health files at content level, issue/PR templates, releases & changelogs, community entry points. New reference:
references/facade-decor.md. audit.py --repofacade mode — live GitHub API checks: About/topics rules, community files with org-fallback awareness (no false "missing" verdicts), issue-template listing, tag/release line consistency, social preview detection viaog:image, plus badge lint (bare badges, style mixing, row length).- Checklist extended to sections A–I with a matching report template.
📚 Repo facade
- Community health files: CONTRIBUTING, Contributor Covenant 2.1 (CoC), SECURITY with private reporting channels (GitHub private vulnerability reporting is enabled).
- Issue forms (bug + rule-change, evidence required) and a PR template with an AI-disclosure section.
- Bilingual READMEs get a badge row, a ≤120-char one-liner, and real contributing/security links.
- License changed from MIT to AGPL-3.0 — free to use including commercially; derivatives and network deployments must share source.
🇨🇳 更新日志
覆盖面从 README/About/topics 扩展到全套门面:新增 facade-decor.md(82 条带证据强度的规则)、审计脚本 --repo 门面模式、审查清单 E–I 段;社区健康文件与 issue/PR 模板齐备;本仓库按自身标准完成门面装饰;许可证改为 AGPL-3.0(强 copyleft,衍生须开源)。
Full Changelog: e1ac4a2...v0.2.0