关于 rust-crate-publishing-readiness
面向准备发布或分享 Rust crate 的开发者,关注消费者实际获得的包,而非运行中服务的部署。涵盖元数据、API 与文档检查、Cargo 试运行及包内容审查。
主要功能
- 01元数据与许可证审查
- 02公共 API 和功能检查
- 03测试、文档与格式检查
- 04Cargo 打包试运行
- 05包内容与密钥检查
- 06发布状态审查
适用场景
- 01准备 crate 发布拉取请求
- 02审查 Cargo 元数据与包文件
- 03诊断打包试运行失败
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ lvtd-llc/ skills --skill rust-crate-publishing-readiness安装后在 Claude Code 中输入/rust-crate-publishing-readiness确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
guidelines.mdagents/openai.yamlreferences/publishing-patterns.mdworkflows/prepare-crate-release.md详细介绍
Rust Crate 发布准备
在发布或分享 Rust crate 之前,请使用此技能。它侧重于面向使用者的软件包,而非运行中服务的部署。
核心工作流
- 核验软件包元数据、许可证、README、仓库和分类。
- 从使用者的角度检查公共 API、功能标志、示例和文档。
- 运行测试、文档检查、格式检查和功能矩阵检查。
- 运行
cargo package或cargo publish --dry-run。 - 检查打包内容,确认没有缺失文件或意外包含机密信息。
- 仅在干净、已标记且经过明确规划的发布状态下发布。
接下来阅读
| 任务 | 加载 |
|---|---|
| 准备 crate 发布 PR | guidelines.md、workflows/prepare-crate-release.md |
| 检查 Cargo 元数据和软件包内容 | references/publishing-patterns.md |
| 诊断 dry-run 失败 | references/publishing-patterns.md |
来源说明
指南改编并转述自 Herbert Wolverson 的《Advanced Hands-On Rust》,尤其是第 15 章“共享库”,以及前面有关测试、文档、基准测试和功能的章节。示例为原创骨架。
评论
支持 Markdown