develop-contribution について
Develop Contributionは、研究プロジェクトの貢献フォルダーを作成または整備するスキルです。証拠計画、再現性、データ倫理、レポート作成を案内し、各貢献を自己完結した形で記録します。
主な機能
- 01貢献フォルダーの作成と整備
- 02主張と根拠の計画
- 03実験実行と手法の記録
- 04データの来歴と倫理の確認
- 05詳細なLaTeXレポートの作成
活用シーン
- 01研究貢献の開始
- 02草稿フォルダーの規約準拠
- 03再現可能な実験の記録
- 04貢献レポートの準備
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ vincenzoimp/ academic-research-skills --skill develop-contributionインストール後、Claude Code で/develop-contributionを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/data.mdethics.mdexperiments.mdmethodology.mdreproduction.md詳細
開発への貢献
contributions/<slug>/ フォルダーを 1 つ作成するか、既存のものを整備してください。badge-general に準拠し、自己完結していて、論文執筆時にコードを読み直さずに済む程度に詳しい report/report.tex を含めます。
まず読むもの
contributions/README.md— badge-general の要件survey/survey.pdfのギャップに関するセクション — 新しい貢献の位置付けを検討する場合references/methodology.md— 評価、統計、図表の方針references/experiments.md— 実行ログと自律的な実験キャンペーンreferences/reproduction.md— 外部研究の再現references/ethics.md— データに関する注意事項references/data.md— データの配置と貢献間でのデータ依存関係(貢献に共有データや大規模データがある場合、または別の貢献の出力を使用する場合)
作成前(両方のモードで実施)
貢献の README にある Positioning セクションに記入します。
- この貢献が裏付ける主張
- 最も近い先行研究との差分(survey/SOTA の citekeys を引用)
- エビデンス計画:何を、どのように測定または収集するか
- 反証条件:どのような結果が主張を否定するか
主張を裏付けるエビデンスの道筋がない場合は、作業を中止してユーザーと相談してください。
作成モード
contributions/_template/をcontributions/<slug>/にコピーします(slug はケバブケース)。- Python コードを使う場合は、貢献独自の
pyproject.toml(name、requires-python、dependencies)を作成し、ルートのpyproject.tomlにある[tool.uv.workspace] membersに"contributions/<slug>"を追加して、ルートからuv sync --all-packagesを実行します(package = falseのルートで通常のuv syncを実行すると、メンバーの依存関係が削除されます)。依存関係が実際に競合する場合は、そのパスをexcludeに移し、ローカルの venv を作成して、README にその旨を記載します。 - フォルダー内で開発します。構成は自由です(
src/、data/、figures/、outputs/、ノートブックなど)。評価を行う場合はreferences/methodology.mdに従います。自律的な実験キャンペーンを含め、主張を裏付けるすべての実行についてreferences/experiments.mdに従った実行ログを残します。外部研究を再現する場合はreferences/reproduction.mdに従います。 - README のバッジチェックリストに事実に沿って記入します。チェックを入れた項目はすべて、フォルダー内にエビデンスが必要です。データについては
references/ethics.mdに照らして確認します。 report/report.texを作成します。動機、SOTA との位置付け(ルートの.bibを引用)、手法、設定、図表を含む結果、制限事項を記載します。次のコマンドでビルドします:make contribution C=<slug>。make checkを実行します。
整備モード
- 作業中フォルダーの内容を棚卸しします。何が存在し、何を主張しているか、バッジチェックリストに照らして何が不足しているかを確認します。
- フォルダー内を整理します。出所を保持し(名前を変更する場合は元のファイル名を記録)、環境を記録し、実行経路が最初から最後まで機能することを検証して、データの出所と倫理上の注意事項を記録します。
- 作成モードの手順 4〜6 を続けます。
ルール
- 自己完結させます。他の貢献からインポートしてはいけません。共有する価値のあるツールは独立した貢献として作成し、README で参照します。入力が別の貢献の出力である場合は、そのことを明記して元の場所から読み込み、コピーしてはいけません(
references/data.mdを参照)。 - 探索的な結果を、確定したエビデンスであるかのように扱ってはいけません。探索的な結果であることを明記します。
- 否定的な結果も結果です。report.tex に記載します。
完了条件
- バッジチェックリストのすべての項目に事実に沿ってチェックが入り、
report.pdfがビルドされ、ワークスペースに一貫性があり、make checkが成功していること
コメント
Markdown 対応