---
# System prepended metadata

title: CW22 submission

---

# CW22 submission

# Submitter's details
- email ::t.lestang@imperial.ac.uk
- First name :: Thibault 
- Surname :: Lestang
- Home institution :: Department of Aeronautics, Imperial College London

## Session collaborators

Matthew Bluteau  
Jeffrey C. Carver  
Fergus Cooper  
Barry Demchak  
Hollydawn Murray  
David A. Nicholson  
Miguel Xochicale

## Mini-workshop or demo session title

Code Review During Development

## Abstract

*If your session is accepted this abstract will be made public on the CW22 website, so please write this as a public description containing 200-400 words.*

Researchers benefit greatly from small and regular code reviews 
during development, in addition to larger end-of-work reviews.
Code review also plays a role in producing sustainable research software. 
However, establishing a culture of code review in research has been made difficult by a lack of guidance and awareness of its benefits. 
Furthermore, while good practices for code review have been established 
in the software industry, 
it is still unclear what processes and workflows work best for code review 
in a research setting.

In this demo session, we will present a guide to code review during development,  
designed for researchers, by researchers. Drafting of this guide has been driven by the Code Review Community, an international and multi-sectoral group interested in advancing code review in research. 
The primary result of this work is a website (https://researchcodereviewcommunity.github.io/dev-review/) 
describing processes that researchers can follow to integrate code review into their daily research routine. 
The guide introduces researchers to code review, 
provides practical advice on how to get started with it, 
and brings together existing resources for reference.
Although the guidelines are built on existing research 
and the experience of Code Review Community members, 
it is a result of discussion within the community 
and has not been extensively tested in the field. 
Our goal is to get feedback and suggestions on the guidance 
currently offered by the Code Review Community, 
and to develop our understanding of code review within research more broadly. 
In particular, we seek to understand whether our guidelines are accessible to all, including underrepresented groups in research.

The intended audience for this demo session is any researcher writing code, 
from short analysis scripts to full-fledged applications. 
After presenting the website we have developed, 
we will split into breakout rooms for discussions with workshop participants. 
After the session, participants will be better equipped 
to foster and sustain code review within their own local research organizations, 
and they will have contributed to the improvement of the 
guidelines.
We will also invite session participants to become 
regular contributors to the Code Review Community.


## Mini-workshop or demo session description

*Please describe your session's aims and outcomes, and how the session connects to the themes of CW22. If you are proposing a 60-minute session, please outline how you plan to facilitate participant interaction.*

We are proposing a 60-minute session, divided in three parts.
The first part, lasting 15-20 minutes, will be dedicated to presenting the website 
that is the primary output of the Code Review Community to date. 
We will of course encourage questions from participants 
during this first part. 
In the second part, 
we will split into breakout groups for 35 minutes, 
to discuss specific sections of the website 
for which we seek feedback. 
Discussion in each group will be facilitated by a member of the Code Review Community.
We plan to assign participants to rooms, allowing for some flexibility 
if some are particularly interested in 
discussing a certain aspect of the site.
After the breakout groups meet, 
we will conclude with all participants 
coming together again for 10 minutes to report out. 
Notes from the discussion will be collected and 
integrated into future development of the website.

## Special requirements, prerequisites or other information to include about the proposed session
There are no requirements or prerequisites.
As part of the information about the session, 
a link to the website we will discuss could be included:
https://researchcodereviewcommunity.github.io/dev-review/  
Again, participants are not required to read the site before the session.