Publish Checklist

对外发布前审查清单。发布 ClawHub skill、提交 GitHub PR/Issue、发帖、发邮件、任何公开内容前必须加载此 skill 并逐项检查。

安装

概览

什么是Publish Checklist

Publish Checklist 是一个专为开发者在对外发布前设计的审查工具,旨在确保所有公开内容符合隐私、安全和可维护性标准。它通过结构化的检查清单,帮助开发者系统性地排查潜在风险,避免因疏忽导致的信息泄露或安全漏洞。无论是发布 ClawHub skill、提交 GitHub 的 Pull Request 或 Issue,还是撰写技术文章和发送邮件,只要涉及对外公开的内容,都必须使用此工具进行逐项验证。该工具的核心理念是‘预防优于修复’,通过强制性的安全检查流程,提升开源项目和企业级代码的健壮性与透明度。其设计兼顾了社区协作需求与内部开发规范,尤其适合需要频繁参与开源贡献或面向公众发布软件产品的团队使用。

核心功能特点

  1. 全面覆盖隐私保护:自动检测并防止用户名、IP、API key、token 等敏感信息泄露
  2. 强化安全机制:要求危险操作必须显式启用参数(如 –force),默认行为无害化设计
  3. 权限最小化原则:仅在必要时申请高权限(如 root),其余操作限制在最低权限范围内
  4. 支持审计追踪:所有关键操作均记录日志,便于事后追溯与责任界定
  5. 输入严格校验:对外部传入参数进行有效性检查,防止恶意输入引发系统异常
  6. 文档透明化:强制要求在文档中清晰说明安全设计与扩展能力,方便社区审查

适用场景

Publish Checklist 适用于多种需要对外发布的开发场景。当开发者准备发布一个 ClawHub skill 到公共平台时,可通过此工具快速确认是否包含内部配置或硬编码密钥,避免误将敏感信息暴露给用户。在提交 GitHub PR 或 Issue 时,该工具能提醒使用双语描述问题,并检查是否无意中上传了高权限凭证,从而维护项目声誉和社区信任。对于撰写技术博客、发布公告邮件或发布任何形式的公开文档,该清单同样适用——它能帮助作者识别可能泄露公司内部逻辑或架构的细节,比如特定服务命名、部署路径等。此外,在企业级项目中,该工具可作为 CI/CD 流程中的前置检查环节,确保每次发布都经过标准化审核,降低生产环境事故风险。无论是个人开发者还是大型团队,只要涉及对外输出代码或信息,都应将 Publish Checklist 纳入发布前的必要流程。