开源

效率工具 社区

技能解读

当前原文的自动摘译,尚未人工审校。

何时使用

公开私有存储库 审核现有公共存储库的发布质量(“使其正式化”) 为项目选择许可证 在公开之前设置打包、版本控制或发布自动化

何时不使用

对已发布的项目进行例行开发(无发布事件) 审核第三方代码是否存在漏洞(使用安全审查技能) 从保持私有的存储库发布包 - 仅适用发布管理步骤;跳过其余部分

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
效率工具
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@trailofbits · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
Python
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:检测组织概况

该脚本检查 git 远程和最近的提交者电子邮件,并打印配置文件名称。如果它打印`trailofbits`,请立即阅读references/trailofbits.md,并在其余步骤中应用其许可证策略、发布帐户和流程注释。如果打印`generic`,请继续执行通用指南

02
第 2 步:首先审核机密

曾经包含秘密(API 密钥、凭证、客户端数据)的存储库不应公开。历史记录重写很容易出错,并且不会到达分叉、缓存或 CI 工件。可靠的修复方法是使用新的存储库:复制当前树,提交并私下归档旧存储库。

03
第 3 步:运行准备情况检查

该脚本会打印一份存在指示符清单(README、LICENSE、CONTRIBUTING、SECURITY.md、CI、测试、semver 标签等),并对通常包含机密的跟踪文件发出警告。将未经检查的项目视为讨论提示,而不是严重失败——研究原型并不需要旗舰图书馆所需的一切。与用户一起走过差距,

04
第 4 步:文档记录

自述文件是该项目的前门。确认它的解释:项目是什么以及它解决什么问题(第一段)如何安装它 - 包管理器、容器映像或从源代码构建;全新克隆构建必须仅使用存储库中的内容如何使用它 - 至少一个具体的、可复制粘贴的示例

05
第 5 步:许可

没有许可证就意味着不开源,无论可见性如何。阅读references/licensing.md 了解选择标准和机制。简短版本:如果在步骤 1 中检测到,则应用组织的策略。否则:Apache 2.0 作为默认许可,AGPLv3 为私有

06
第 6 步:测试和 CI

确认测试套件存在并通过;具有失败默认分支的公共存储库表示放弃。确保 CI 在每个 PR 上运行测试,跨受支持的语言版本和平台矩阵。在 CI 中强制执行格式化和 linting(每个语言的工具)

07
第7步:存储库设置

默认分支上的分支保护:无需强制推送,需要 PR。更喜欢新存储库的规则集;经典分支保护仍然受支持。合并保护:需要进行状态检查,以便 PR 无法与失败的测试合并。

08
第 8 步:发布和版本控制

标记每个版本`vX.Y.Z`,遵循 semver;对候选发布版和预发布版使用 `-rc.N` / `-pre.N` 后缀。使版本由 CI 驱动:推送标签(或发布 GitHub 版本)会触发构建、打包和上传,无需手动步骤。版本应该是`git tag vX.Y.Z && git push origin vX.Y.Z`。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。