github-repository-presentation
/github-repository-presentation
为 GitHub 仓库按统一模板编写或优化中英双语 README、项目 Description、Topics、使用说明等公开解释性文字,规范真实功能截图与 GitHub Release Notes 的双语表达。当用户要求仓库首页、封面、功能截图、技术徽章、文案或展示质量时使用;不负责 Git 提交、版本事实判定或远端发布。
- Author
- HaoyanZhang123 ↗
- Repository
- control-your-skills ↗
- Licence
- MIT
- Last repository change
- 11.11.2026
Assessment and security
- Files in this package
- 2
- Scripts
- 0
- HTML comments
- 2
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 11.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
- SKILL.md zawiera komentarze HTML (2). Nie widać ich w podglądzie Markdown, a model je czyta.
What it does and when to use it
为 GitHub 仓库按统一模板编写或优化中英双语 README、项目 Description、Topics、使用说明等公开解释性文字,规范真实功能截图与 GitHub Release Notes 的双语表达。当用户要求仓库首页、封面、功能截图、技术徽章、文案或展示质量时使用;不负责 Git 提交、版本事实判定或远端发布。
Original author description
为 GitHub 仓库按统一模板编写或优化中英双语 README、项目 Description、Topics、使用说明等公开解释性文字,规范真实功能截图与 GitHub Release Notes 的双语表达。当用户要求仓库首页、封面、功能截图、技术徽章、文案或展示质量时使用;不负责 Git 提交、版本事实判定或远端发布。
How it works
- 使命与边界
- 统一文字与视觉标准
- README 统一模板规范
- 其他解释性文字
- Release Notes 双语排版约束
- 完成前核对
SKILL.md preview
--- name: github-repository-presentation description: 为 GitHub 仓库按统一模板编写或优化中英双语 README、项目 Description、Topics、使用说明等公开解释性文字,规范真实功能截图与 GitHub Release Notes 的双语表达。当用户要求仓库首页、封面、功能截图、技术徽章、文案或展示质量时使用;不负责 Git 提交、版本事实判定或远端发布。 --- # GitHub 仓库呈现规范(统一双语模板) ## 使命与边界 为不同仓库应用**同一套 README 结构、视觉语言和中英双语写作规则**,得到高级、克制、清晰、准确的 GitHub 页面。根据项目事实填入内容,而不是按项目类型切换模板。 - 先按需读取真实 README、入口、依赖与配置、使用方式、许可证、相关图片和版本信息;不为写文案遍历整个仓库。 - 本 Skill 主导 README、Description、Topics、公开说明的结构与文字呈现;Release Notes 只规定表达模板与可读性,版本范围、变更事实、提交与发布操作由 `git-release-hygiene` 或实际任务证据决定。 - 在获准的文件范围内可修改文档;修改 GitHub 远端 About/Topics、推送或发布必须符合明确授权和实际权限。 - 不修改业务功能,不夸大能力,不虚构命令、链接、性能、许可证、截图、版本状态、验证经历或变更数量。 ## 统一文字与视觉标准 1. **双语用两个文件,不在一个文件里逐段对照**:主 `README.md` 写英文(GitHub 默认展示),`README.zh.md` 写中文;两份都在顶部放指向对方的语言切换链接(如 `[中文](README.zh.md)` / `[English](README.md)`)。两份内容完整对应、各自可独立阅读,语序和章节顺序一致。技术名、命令、文件路径、代码和既有专有名词不强行翻译。代码块各自保留一份。 2. **单一视觉系统**:采用克制、现代、专业的技术项目气质。统一标题层级、图片宽度、徽章风格、段落节奏;默认避免无意义 Emoji、营销形容词、花哨分隔线及装饰性表格。 3. **具体胜于空泛**:说明项目做什么、适用于谁、如何开始、现有限制。避免“最强”“革命性”“全面支持”等无依据表达。 4. **事实分级**:实际文件和已确认行为优先;项目自述、未验证示例、计划功能与模型推断不得混写。未知事实标注或向用户确认;不把尚未运行的命令说成已验证。 5. **同一骨架、按需减法**:README 核心部分顺序固定。配置、目录结构、扩展说明等确实不适用时可省略,不能为凑齐章节制造内容。 ## README 统一模板规范 按以下顺序组织;不另外设计 A/B/C 多套风格。 1. **顶部封面图(默认必备)**:README 的首个可见主体是一张横幅封面,建议约 `2:1`,宽度适配 GitHub。封面应以简洁图形、真实产品界面或准确抽象示意传达项目内容;少字或无字,避免虚构功能界面。图像需位于仓库可访问的稳定路径,具有与当前文件语言一致的 `alt`。 - **缺少封面时**:先寻找现有可用素材;若没有,提出封面设计方案并请求提供素材或授权创建。未取得可用图片前不要写失效的 `src`,也不把占位图当成最终成品。可先交付其余 README 草稿并明确封面待补。 2. **项目身份**:居中的项目名与一句话定位;当前文件用哪种语言,定位就用哪种语言,不在一行里并列两种语言。短而准确,不叠加多个口号。 3. **可点击技术栈徽章**:紧接项目定位,优先展示约 3–8 项确实使用的核心技术或依赖平台;采用风格统一的 Badge,点击后指向对应官方文档或项目主页。无依据不得添加技术,不使用 `#` 假链接;非软件项目可使用实际相关的运行环境、数据格式或技术平台,不能强造“技术栈”。 4. **其他状态徽章(可选)**:仅在信息真实且有有效目标链接时展示 License、Release、CI、Docs、Demo 等;建议少量且一致,不为装饰而堆积。 5. **简短导航(可选)**:仅在 README 较长时添加 4–7 个真实可用的章节链接,核对 GitHub 实际锚点。 6. **简介 / Overview**:用一到两段说明项目是什么、解决什么问题、适用对象与主要价值;标题按当前文件语言书写。 7. **核心特性 / Features**:按用户可感知的能力列出精炼要点,只写已实现或明确标为实验性的功能,不把开发计划列为当前能力。 8. **安装 / Installation**:给出最短可信安装路径、必要前提、可复制命令。若不需要安装,明确说明获取与使用方式,而不是编造安装命令。 9. **使用方式 / Usage**:至少展示一个适用的最小操作示例、命令或实际 UI 流程;技术细节复杂时链接到已有文档,README 不变成完整手册。 10. **配置 / Configuration(按需)**:只列关键配置和重要环境变量;不得展示真实密钥,复杂配置链接到已有文档。 11. **项目结构 / Project Structure(按需)**:只呈现帮助首次理解的核心目录;不逐文件罗列。 12. **更新与发布 / Releases(按需)**:仅提供真实 Releases 或 Changelog 入口及必要状态,不在 README 内复制完整版本历史。 13. **许可证 / License**:如有真实许可证,准确说明并链接 LICENSE;如未声明,不推断为 MIT、Apache 或其他开源许可,必要时明确“尚未声明许可证 / No license specified”。 ### 排版约定 一个主封面;`<h1>` 仅用于项目标题,章节用 `##`;居中只用于首页头部,正文左对齐;图片用仓库相对路径并适配窄屏;重要命令与链接必须可核对,不输出伪造徽章、无效锚点或占位符成品。 ### 功能截图与操作说明 当真实界面、运行结果或操作流程比文字更容易解释功能时,可在对应章节配少量真实截图。截图用于补充理解,不替代可复制的命令、参数和步骤。 - **位置与数量**:优先在「使用方式 / Usage」放主界面或最小真实流程图;「核心特性 / Features」「配置 / Configuration」仅在确有理解收益时配图。主 README 默认配 **0–5 张功能截图**(不含顶部封面);只有复杂流程、多个核心界面或长文档确有需要时才增加,并逐张说明必要性。安装命令、License、目录结构等用文字或代码块已能清楚表达的内容不强行配图。 - **真实与授权**:优先使用仓库已有素材或经授权获取的真实运行截图;缺少素材时明确待补或不放,不伪造 UI、运行结果、数据、性能或功能状态。示意图必须明确标注,不得冒充真实界面或功能证据。 - **敏感信息**:公开前检查并清理令牌、账号、内部域名、隐私数据、密钥和本机敏感路径;无法安全清理时不使用该图。 - **文件与排版**:图片放在仓库内稳定、可公开访问的路径(如 `docs/images/`),使用有意义的小写 kebab-case 文件名和仓库相对路径。静态截图优先 PNG;短动画只在确实能解释流程时使用。保持原图比例,适配窄屏,不拉伸、不用失真的放大图。 - **双语与图注**:`README.md` 与 `README.zh.md` 可共用图片文件,但 `alt` 与图注按各自语言书写,准确说明图片对应的真实功能,不写营销口号。同一截图不重复使用,除非确有不同解释目的。 ### README 固定结构示意 双语的骨架较长,已拆到 `references/readme-template.md`:真要落笔写 README 时再打开, 按槽位替换成真实值。只调整措辞、不改结构时不必读它。 ## 其他解释性文字 - **Description**:使用一条精炼的中英双语介绍,优先保证准确和自然;遵守 GitHub 字符上限。若双语信息确实无法在限制内准确表达,向用户提出取舍而不是自行改成单语或截断。 - **Topics**:只使用真实领域、用途和生态关键词;遵守 GitHub 当前格式与数量约束。Topics 本质是检索标签,不要求硬译成中英两套。 - **补充文档**:写明适用语言,或同样提供两个文件互链;侧重读者真实操作,不重复 README 全文。 - **PR、Changelog、Release Notes**:使用完整中文版 + 完整英文版两个独立段落,不逐句对照;具体变更归属、Git 证据、版本判定与发布流程以 `git-release-hygiene` 为准。 ## Release Notes 双语排版约束 **完整中文版在前,完整英文版在后,两个独立段落**:不逐句对照、不左右并列。GitHub 已有版本标题时正文不再重复大标题。 1. **结构**:`## 中文` 与 `## English` 各写完整一份,类别、条目数和事实完全一致。 2. **变更数量**:中文用 `新增/优化/修复`,英文用 `Added/Improved/Fixed`;计数单位是归并后、面向用户的变更事项,不是代码行数、文件数或 Commit 数。 3. **具体变化**:突出用户可感知变化,不贴实现细节、长日志或逐条 Commit;无相应变化的组直接省略。 4. **重要提醒**:不兼容变更、必要迁移、已知风险必须在两种语言里都写明;无证据时不得宣称“无破坏性变更”。 5. **事实不足**:版本范围、数量无法核实时标明待核实,不编造数字与日期,不把草稿说成已发布。 ### Release Notes 固定结构示意 ````markdown ## 中文 本次更新主要……。 **变更概览**:新增 X 项 · 优化 Y 项 · 修复 Z 项 **新增** / **优化** / **修复**(仅保留有内容的类别) - 中文事项。 <!-- 必要时增加 **重要说明** --> ## English This release focuses on ... . **Summary**: Added X · Improved Y · Fixed Z **Added** / **Improved** / **Fixed** (only non-empty groups) - English item. <!-- Add **Important Notes** only when needed --> ```` `X/Y/Z` 仅为槽位;最终只保留有变更且计数可核实的类别,版本与日期用已确认信息。 ## 完成前核对 - README 是否从真实、可访问的项目封面开始?技术栈徽章是否真实且可点击? - 是否沿用唯一固定骨架,且 `README.md` 与 `README.zh.md` 互链、内容完整对应、没有虚构或多余填充? - 安装、使用、许可证、重要链接和视觉素材是否与工作区事实相符?未知项是否明确处理? - 功能截图是否默认控制在 0–5 张,超出是否确有必要,且每张图都服务于明确章节,而不是装饰或重复? - 截图是否真实、可访问、与当前版本一致,并已清理敏感信息?是否存在失效路径、伪造界面或未标注的示意图? - 两份 README 的图片引用是否一致且有效,`alt` 与图注是否符合各自语言?命令、参数与操作步骤是否仍保留可复制文本? - Description、Topics 与 README 是否保持一致? - Release Notes、CHANGELOG 与 PR 描述是否为「完整中文段 + 完整英文段」,而不是逐句对照?数量是否真实、是否保留必要升级警示? - 是否仅执行了本次授权的文件改动和远端操作?交付时是否准确说明未验证与未执行事项?
Files in this package (2)
- SKILL.md 11 KB
- references/readme-template.md 1 KB
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · HaoyanZhang123/control-your-skills | 100 | MIT |
| jaxhu1108/dsh-agent-team-presets | 100 | MIT |
Database snapshot: 13.11.2026 · package version 6af5bf9b5053 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100repo-cleaner
Improve a GitHub repository's public presentation and discovery through README structure, banners, real showcases, accurate badges, installation guides, documentation navigation, About text, topics, and social preview assets. Use for repository makeovers, README redesigns,… - 100github-repo-curator
Organize GitHub repositories for professional presentation and maintainability. README templates, documentation standards, repo organization patterns, and profile optimization. Triggers on GitHub cleanup, repo organization, README writing, or open source presentation requests. - 100write-readme
为 GitHub 项目创建或改写高质量、可执行、证据驱动的双语 README;当用户要求写 README、项目说明或整理项目首页时使用。优先依据项目事实核验功能、命令和链接。 - 100repo-readme-optimizer
Writes or audits a GitHub README and repo card (About line, topics, social preview) for an open-source tool, SDK, plugin or MCP server so it ranks in Google and gets cited by AI assistants. Use when asked to write a README, review a GitHub README, README best practices or make a repo rank. - 100release-notes
Generates Markdown release notes for the most recent release of a GitHub repository. Use when the user asks to "generate release notes", "write a changelog", or "summarize the last release" for a GitHub repo (owner/repo or full URL). - 100github-seo
Makes an open-source GitHub repo discoverable and safe to publish. Audits the repo name, description, topics and README for search, writes a search-ready README, runs a pre-publish secret and client-data check, and guides the launch sequence. Covers MCP server registry…