仓库清理器 是做什么的?
让优秀项目的目标、佐证和首步有用操作更易被找到。优化仓库表层呈现,同时保持应用行为不变。
1. 建立需求简报
- 确定仓库、受众、预期成果、语言,以及是审计还是实施。复用已获得的授权。
- 阅读适用的说明、README、关联指南、许可证、包/技能清单、示例、资产和当前的 GitHub 元数据。仅在需要验证声明和命令时检查源码。
- 检查工作树,保留不相关的更改、现有许可证和署名。除非明确授权更改可见性,否则保持可见性不变。
- 就缺失的事实或有重大影响的选择提出有针对性的问题:受众、冲突的品牌、无法获得的访问权限、不确定的安装,或意义重大的品牌重塑。根据项目自身解决常规布局选择。在等待期间继续独立工作;不要为了回避提问而编造事实。
- 如果需要工作简报,可使用 assets/repo-brief.md;请勿将其添加到每个目标仓库中。
2. 审计读者路径
阅读 references/audit-and-validation.md。追踪路径:发现 → 首屏 → 证据 → 安装 → 首次成功 → 更深入的帮助。
列出少数几个差距最大的问题,附上证据和优先级。将事实性问题与品味选择分开。包括需要移除的冗余内容。区分缺失信息与您的工具无法获取的信息。如果只做审计工作,则返回发现结果和具体建议,不编辑文件或设置。
3. 构建一致的展示效果
阅读 references/readme-and-visuals.md。默认使用 GitHub 原生文档样式、标准扁平徽章、普通导航链接和项目特定的证据。除非有要求,否则不要复用作者个人资料的审美风格。在选择结构或从参考仓库学习时,阅读 references/readme-patterns.md。选择适合项目的方向,然后实现使其易于理解和使用的最小完整资产和文档集。
- 以具体承诺、有用的可视化证据和清晰的首步操作为引导。将重要信息保留为真实文本。
- 仅在有用时添加横幅;优先选择具体任务、实际输出或有用的展示,而非装饰性品牌;从实际输出中截取屏幕截图。准确标注概念、固件、重构和本地预览。
- 添加克制徽章行,包含有效的目标链接和有依据的声明。
- 在 README 中保留最短经过验证的安装和使用示例。链接更长的平台指南、故障排除和示例,避免重复。
- 组织公共文档和资产,不移动应用源码或更改运行时/构建行为。移动文档时更新链接。
- 使文档深度与项目匹配。移除通用的营销文案、重复的标语、强制性的功能表格、冗余章节、徽章墙、装饰性图表和空文件夹层级。保留项目特有的语气。
对于技能仓库,验证可安装文件夹包含 SKILL.md 和每个引用的资源。将该包与公共营销文档分开。按主机记录准确的发现路径、调用示例、前提条件和工具要求。说明每条路径是经过运行时测试、对照主机文档检查过,还是仅可手动使用。不要从普通的技能文件夹推断存在插件、市场列表或通用代理支持。
4. 通过真实的元数据改进可发现性
阅读 references/github-discovery.md。提出简洁的 About 文本、可用的真实主页(如果有)、有证据支持的话题,以及社交预览资产。在应用前检查当前 GitHub 的限制。
使用合适的工具应用已授权的设置,保留相关现有值。如果工具缺少某个操作,则准备精确的值和设置链接。区分 已应用、已准备 和 已阻止。已提交的元数据文件或社交预览图片不能配置 GitHub。未经授权,切勿更改可见性、联系他人或提交推广列表。
5. 验证与交付
根据审计参考验证读者路径:链接和锚点、图片、安全的快速启动、真实的徽章和兼容性、桌面/移动端、浅色/深色模式、最终差异和设置回读。明确报告工具或网络的限制。保存源资产,以便后续更新保持可行。
仅在获得授权时提交或推送,并遵循目标仓库的工作流。确认目标仓库和最终修订版本。总结更改、验证、未应用的设置和剩余少量操作。不要承诺流量、星标、排名或未经测试的支持。