关于 package-artifacts
这是一项用于组装研究成果评审包的技能,面向审稿人或制品评估委员会。它指导整理论文承诺的内容、记录文件、清除敏感材料,并在独立环境中验证。
主要功能
- 01将论文主张对应到所需制品
- 02暂存自包含的贡献目录
- 03创建 README、许可证、引用文件和校验清单
- 04移除机密与敏感文件
- 05检查独立运行及会议要求
适用场景
- 01准备论文评审制品包
- 02打包供评估的代码、数据和脚本
- 03核对会议徽章要求
- 04在源仓库之外测试制品包
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ vincenzoimp/ academic-research-skills --skill package-artifacts安装后在 Claude Code 中输入/package-artifacts确认已加载。
附带文件references/artifact-standard.md
详细介绍
软件包工件
组装 papers/<slug>/artifacts/:提供给审稿人或工件评估委员会的自包含软件包。
请先阅读
papers/<slug>/venue.md— 会议或期刊的徽章/工件要求papers/<slug>/manuscript/main.tex— 论文承诺提供的内容references/artifact-standard.md
流程
- 列出必须随包提供的内容:论文中承诺提供的所有工件(数据、 代码、模型、脚本),以及会议或期刊徽章要求的所有内容。
- 将相关的
contributions/<slug>/文件夹复制到artifacts/中进行暂存—— 这些文件夹在构建时已自包含。绝不手动编辑暂存副本:应在源贡献中修复问题,然后重新暂存。 - 添加软件包级文件:工件 README(包含主张与工件的对应关系、设置方法、
冒烟测试、预期输出和运行时间)、许可证、引用文件,以及列出每个文件及其
sha256 校验和的
MANIFEST.md。 - 移除不得随包提供的内容:被 git 忽略的材料、机密、原始敏感 数据,以及在会议或期刊要求匿名时可识别身份的路径和名称。
- 验证独立运行:软件包无需依赖周围的仓库即可运行(不含
../引用,参考文献已解析,环境声明包含在包内)。 - 逐项检查
references/artifact-standard.md和会议或期刊检查清单;在工件 README 中记录对应关系。
规则
- 绝不手动编辑暂存的贡献副本:应在源贡献中修复问题,然后重新暂存。
- 发布前移除被 git 忽略的材料、机密和原始敏感数据。
- 软件包必须自包含:环境、数据来源信息和参考文献均在包内解析——不含
../引用或外部路径。
完成标准
- 软件包满足会议或期刊的要求和工件标准,
MANIFEST.md校验和为最新,并且干净环境冒烟测试(在其他位置全新解压,仅按软件包 README 操作)成功
评论
支持 Markdown