关于 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>/ 文件夹:符合 badge-general 要求、内容自包含,并且其中的 report/report.tex 足够详尽,无需为了撰写论文而重新阅读代码。
请先阅读
contributions/README.md— badge-general 规范survey/survey.pdf的 gaps 部分 — 为新贡献确定定位时阅读references/methodology.md— 评估、统计和图表规范references/experiments.md— 运行日志和自主实验活动references/reproduction.md— 复现外部工作references/ethics.md— 数据风险提示references/data.md— 数据存放位置及贡献之间的数据依赖(当贡献包含共享数据、大型数据,或使用另一项贡献的输出时)
开始构建前(两种模式均适用)
填写贡献 README 中的 Positioning 部分:
- 此贡献要支持的主张
- 与最接近的既有工作的差异(引用 survey/SOTA citekey)
- 证据计划:将测量或收集什么,以及如何进行
- 可证伪条件:什么结果会推翻该主张
如果该主张没有可行的取证路径,请停止并与用户讨论。
创建模式
- 将
contributions/_template/复制到contributions/<slug>/(使用 kebab-case 命名 slug)。 - 使用 Python 代码?编写该贡献自己的
pyproject.toml(包含 name、requires-python、dependencies),在根目录的pyproject.toml中将"contributions/<slug>"添加到[tool.uv.workspace] members,然后从根目录运行uv sync --all-packages(根目录设置为package = false时,普通的uv sync会移除各成员的依赖)。如果确实存在依赖冲突 → 将该路径移至exclude,创建本地 venv,并在 README 中说明。 - 在文件夹内开发 — 结构不限(
src/、data/、figures/、outputs/、notebooks)。任何评估都须遵循references/methodology.md;对于每次支持某项主张的运行(包括自主实验活动),都须按照references/experiments.md保留运行日志。复现外部工作时,须遵循references/reproduction.md。 - 如实填写 README 中的 badge 清单 — 每个勾选项都须有文件夹内的证据。根据
references/ethics.md检查数据。 - 编写
report/report.tex:包括动机、相对于 SOTA 的定位(引用根目录.bib)、方法、设置、含图表的结果以及局限性。构建报告:make contribution C=<slug>。 - 运行
make check。
规范化模式
- 清点草稿文件夹:现有内容、主张内容,以及对照 badge 清单仍缺少的内容。
- 原地重新整理 — 保留来源信息(重命名时记录原文件名),记录环境,端到端验证运行路径,并记录数据来源及伦理标记。
- 继续执行创建模式的步骤 4–6。
规则
- 自包含:不得从其他贡献导入内容;值得共享的工具应作为独立贡献,并在 README 中引用。如果输入是另一项贡献的输出,应声明该依赖并原地读取 — 切勿复制(见
references/data.md)。 - 探索性结果不得冒充已确认的证据 — 须明确标注。
- 负面结果也是结果:须在 report.tex 中报告。
完成条件
- badge 清单已如实全部勾选,
report.pdf已构建,工作区结构一致,且make check通过
评论
支持 Markdown