package-artifacts について
査読者や成果物評価委員会向けに、自己完結型の研究成果物バンドルを組み立てるスキルです。論文で約束した内容の配置、記録、機密情報の除去、クリーンな環境での検証を案内します。
主な機能
- 01論文の主張と必要な成果物の対応付け
- 02自己完結型の貢献フォルダーの配置
- 03README、ライセンス、引用ファイル、チェックサム一覧の作成
- 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 対応