Suppr超能文献

科学代码评审的十个简单规则。

Ten simple rules for scientific code review.

机构信息

Department of Psychology and eScience Institute, University of Washington, Seattle, Washington, United States of America.

出版信息

PLoS Comput Biol. 2024 Sep 5;20(9):e1012375. doi: 10.1371/journal.pcbi.1012375. eCollection 2024 Sep.

Abstract

As large, high-dimensional data have become more common, software development is playing an increasingly important role in research across many different fields. This creates a need to adopt software engineering practices in research settings. Code review is the engineering practice of giving and receiving detailed feedback on a computer program. Consistent and continuous examination of the evolution of computer programs by others has been shown to be beneficial, especially when reviewers are familiar with the technical aspects of the software and also when they possess relevant domain expertise. The rules described in the present article provide information about the why, when, and how of code review. They provide the motivation for continual code reviews as a natural part of a rigorous research program. They provide practical guidelines for conducting review of code both in person, as a "lab meeting for code," as well as asynchronously, using industry-standard online tools. A set of guidelines is provided for the nitty-gritty details of code review, as well as for the etiquette of such a review. Both the technical and the social aspects of code review are covered to provide the reader with a comprehensive approach that facilitates an effective, enjoyable, and educational approach to code review.

摘要

随着大型、高维数据变得越来越常见,软件开发在许多不同领域的研究中发挥着越来越重要的作用。这就需要在研究环境中采用软件工程实践。代码审查是一种工程实践,即对计算机程序进行详细的反馈。事实证明,由他人对计算机程序的演变进行一致和持续的检查是有益的,特别是当审查者熟悉软件的技术方面,并且具有相关的领域专业知识时。本文中描述的规则提供了有关代码审查的原因、时间和方式的信息。它们为将持续的代码审查作为严格研究计划的自然组成部分提供了动力。它们为面对面的代码审查(例如“代码实验室会议”)以及使用行业标准的在线工具进行异步审查提供了实用的指导方针。本文还提供了一套有关代码审查的细节和审查礼仪的准则。涵盖了代码审查的技术和社会方面,为读者提供了一种全面的方法,有助于实现有效、愉快和具有教育意义的代码审查。

相似文献

1
Ten simple rules for scientific code review.科学代码评审的十个简单规则。
PLoS Comput Biol. 2024 Sep 5;20(9):e1012375. doi: 10.1371/journal.pcbi.1012375. eCollection 2024 Sep.
4
Ten simple rules on writing clean and reliable open-source scientific software.关于编写干净可靠的开源科学软件的十则简单规则。
PLoS Comput Biol. 2021 Nov 11;17(11):e1009481. doi: 10.1371/journal.pcbi.1009481. eCollection 2021 Nov.
7
The future of Cochrane Neonatal.考克兰新生儿协作网的未来。
Early Hum Dev. 2020 Nov;150:105191. doi: 10.1016/j.earlhumdev.2020.105191. Epub 2020 Sep 12.
8
9
A how-to guide for code sharing in biology.生物学代码共享指南
PLoS Biol. 2024 Sep 10;22(9):e3002815. doi: 10.1371/journal.pbio.3002815. eCollection 2024 Sep.

本文引用的文献

1
Evaluating the Reliability of Human Brain White Matter Tractometry.评估人脑白质纤维束测量法的可靠性。
Apert Neuro. 2021;1(1). doi: 10.52294/e6198273-b8e3-4b63-babb-6e6b0da10669. Epub 2021 Nov 17.
3
Ten simple rules for making research software more robust.使研究软件更稳健的十条简单规则。
PLoS Comput Biol. 2017 Apr 13;13(4):e1005412. doi: 10.1371/journal.pcbi.1005412. eCollection 2017 Apr.
4
Ten Simple Rules for Taking Advantage of Git and GitHub.利用Git和GitHub的十条简单规则。
PLoS Comput Biol. 2016 Jul 14;12(7):e1004947. doi: 10.1371/journal.pcbi.1004947. eCollection 2016 Jul.
6
Dipy, a library for the analysis of diffusion MRI data.Dipy,一个用于分析扩散磁共振成像数据的库。
Front Neuroinform. 2014 Feb 21;8:8. doi: 10.3389/fninf.2014.00008. eCollection 2014.
7
Ten simple rules for reproducible computational research.可重复计算研究的十条简单规则。
PLoS Comput Biol. 2013 Oct;9(10):e1003285. doi: 10.1371/journal.pcbi.1003285. Epub 2013 Oct 24.

文献AI研究员

20分钟写一篇综述,助力文献阅读效率提升50倍。

立即体验

用中文搜PubMed

大模型驱动的PubMed中文搜索引擎

马上搜索

文档翻译

学术文献翻译模型,支持多种主流文档格式。

立即体验