ARTICLE DETAIL

资讯详情

深耕网站建设、视觉设计与SEO优化的一线实战洞察。

如何正确引用《Good Research Code Handbook》并参与开源社区:研究者的行动指南

如何正确引用《Good Research Code Handbook》并参与开源社区:研究者的行动指南 如何正确引用《Good Research Code Handbook》并参与开源社区研究者的行动指南【免费下载链接】codebookThe Good Research Code Handbook项目地址: https://gitcode.com/gh_mirrors/code/codebook《Good Research Code Handbook》好研究代码手册是面向科研编程者的开源实践指南教你用软件工程方法写出可维护、可复用的研究代码。本文带你完成两件关键小事正确引用这本手册以及以研究者身份参与开源社区——不需要深厚技术背景5 分钟就能迈出第一步。为什么引用这本研究代码手册很重要 这本手册由神经科学研究者 Patrick Mineault 撰写把 Git 版本控制、测试、文档、代码评审等软件工程实践带进实验室场景。它已在 Zenodo 获得学术数字对象标识符DOI意味着你可以像引用论文一样规范地引用它。引用规范的手册能体现你研究流程的严谨性——就像研究代码本身也需要版本控制一样下图是科研人熟悉的 FINAL.doc 版本困境正是 Git 想帮你解决的Good Research Code Handbook 标准引用格式手册在 README.md 的 Citing this book 一节给出了官方引用信息DOI 为10.5281/zenodo.5796873Zenodo2021 年发布。标准引用写法如下Patrick J Mineault The Good Research Code Handbook Community (2021).The Good Research Code Handbook. Zenodo. doi:10.5281/zenodo.5796873BibTeX 用户可以从 Zenodo 记录页直接导出条目使用 Zotero 等文献管理工具时直接搜索该 DOI 即可自动导入。注意两点手册以CC-BY 4.0 许可发布见 LICENSE允许你在署名后自由分享与改编——这为二次创作型引用提供了许可基础。引用时保留 The Good Research Code Handbook Community 这一共同作者因为手册由社区协作维护。参与开源社区分步指南从 Issue 到 Pull Request 手册的社区章节 docs/social.md 专门讨论了参与开源Participate in open source给出的路径对新手非常友好第一步先提一个 Issue试水不必一开始就改代码。打开你常用软件项目的 Issue 区提一个清晰的问题或 Bug 报告观察社区响应速度与态度。响应友好、讨论认真就说明这个社区适合你深入参与。第二步用 Pull Request 提交小改动Issue 被认可后可以发起 Pull Request 添加功能或修错。手册特别提醒先开 Issue 说明你的计划因为大型项目对新功能增加长期维护负担通常比较谨慎。第三步用代码评审和结对编程持续学习参与开源不只是提交代码更重要的是读别人的代码。手册介绍了两种高效方式Code review代码评审用 Pull Request 做逐行异步反馈或在实验室里组建代码评审圈像组会一样一起读代码、提意见。Pair programming结对编程一人担任驾驶员写代码一人担任领航员把控结构每次 1 小时特别适合学习文档不足的遗留系统。研究代码实践彼此环环相扣形成一个以可复现研究为目标的网络如下图所示——你的每次贡献都会强化其中一环找到你的科研编程社区 ‍手册还建议你走出实验室找同类本地黑客空间Hacker space、Python 与数据科学 Meetup、面向弱势群体的安全社区甚至程序员深度训练营。在线工作坊是最低成本的入口下图就是一场数百人参与的研究代码线上工作坊场景而浏览你关注的开源项目主页就是建立连接的第一步项目资料速查引用与社区内容在哪里 ️内容位置官方引用信息与 DOIREADME.md Citing this book 一节社区参与、代码评审、结对编程docs/social.md全书目录结构docs/_toc.yml许可证CC-BY 4.0LICENSEPDF 版本docs/_static/book.pdf一句话总结引用时带上 DOI 10.5281/zenodo.5796873 和完整社区作者署名参与时遵循提 Issue → 小步 Pull Request → 评审与结对的路径。正如手册所说真正好的研究代码是一路走来的朋友们共同打造的 【免费下载链接】codebookThe Good Research Code Handbook项目地址: https://gitcode.com/gh_mirrors/code/codebook创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表