# Code Reviewing and testing: from a unit to a community
**Workshop format:**
1st part:
Intro
Hands-on Reviewing Exercise
Testing Theory (external speaker, see list below)
2nd part:
communities - local to wider network
interactive exercise on how to build and maintain communities for testing and review (and for much more)
**List of speakers, please add and prioritize**
Daan van Vught (NL RSE)
Barbara Vreede (escience center)
Kees Burger (LUMC)
Niels Doorn (OU, NHL Steden) https://research.nielsdoorn.nl/
Andy Zaidman/Baris Ardic (TU Delft, CS Education)
**We will need to fill in this for the proposal:**
*Names and contact details of organiser(s):*
*Format and structure;*
*Title and short description that summarizes the workshop/session/presentation, its rationale and relevance for the participants of the National Open Science Festival (max. 500 words for workshops and sessions, 250 words for the Marketplace);*
*Target audience;*
Researchers, Research Support staff
*Preferred outcomes for participants of the workshop/session;*
Awareness that code testing is useful and good practice, being more comfortable sharing their own code, taking home ideas on how to start regular code reviews in their daily work
*Requirements (screens, set up of tables, flipcharts, etc.)*
Participants need to bring own laptops, enough power outlets in the room, possibly extension cords, set up so that participants can share one screen
-----------------------------
-----------------------------
*Old notes*
Input CDS: structures for code reviews, community building https://researchsoftware.pubpub.org
Input escience center: technical part of code reviews, materials for teaching
Input Daniela: materials, examples, spread the word
Ideas for session:
Introduction: Why is code review important? Why don't we do it more often and how does it figure in a transparent research software pipeline (from research idea to post-publication), where does it fit in Open Science
Take-away for participants: two things they can implement/try to implement the day after OSF
chatGPT for code review?
Background info: Differences between code review of analysis code, software/tools and a reproducibility check.
- Invited expert speaker? Does e-Science center have experts on this who can contribute? Otherwise SURF/TNO/RIVM
- practice code reviewing
- four eye programming
- buddy systems
- Hacky hour
- ???
- setting up your own community - what can you do? Where do you start?
# Proposal
Names and contact details of organiser(s):
Organisers:
Daniela Gawehns, gawehnsd@liacs.leidenuniv.nl, Leiden University
Kristina Hettne, k.m.hettne@library.leidenuniv.nl, Leiden University
Dan Rudmann, d.a.rudmann@library.leidenuniv.nl, Leiden University
Lieke de Boer, l.deboer@esciencecenter.nl, Netherlands eScience Center
**Format and structure:**
The workshop "Code Reviewing and Testing: from a Unit to a Community" will be divided into two parts. In the first part, a code testing expert will introduce the importance of code reviewing and the theoretical background of testing. Then, participants will engage in a hands-on reviewing exercise. In the second part, participants will learn about building and maintaining communities for testing and review through an interactive exercise.
Title and short description that summarizes the workshop/session/presentation:
**Title: Code Reviewing and Testing: from a Unit to a Community**
Description:
Sharing code and research software is an important part of Open Science. Research software needs to be well-written, well-documented, and well-tested for it to be used by others and to produce accurate and reproducible results. By performing code reviews and writing tests, researchers can identify and fix errors in research software / code. Code review and testing ensure that the software used in research is of high quality, which helps to increase the reliability and reproducibility of research results. Despite this, testing and code review are not common practice in many areas of research.
This workshop aims to provide researchers and research support staff with the knowledge and skills to effectively review and test code in a collaborative manner. Through a combination of a lecture and practical exercises, participants will learn about the importance of code reviewing and how to build and maintain communities for testing and review.
The workshop is relevant for anyone involved in research software development, as it promotes good practices and transparency in the research pipeline. Additionally, promoting the practices of code review and testing contribute to Open Science, as they enable the replication and validation of research results.
**Target audience**
The target audience for this workshop is researchers and research support staff who are involved in software development. It is suitable for participants with varying levels of experience in code reviewing and testing.
**Preferred outcomes for participants of the workshop/session**
At the end of the workshop, participants will be aware of the importance of code testing and good practices in research software development. They will be more comfortable sharing their own code and taking home ideas on how to start regular code reviews in their daily work. Participants will also learn how to build and maintain communities for testing and review.
**Requirements (screens, set up of tables, flipcharts, etc.)**
Participants are required to bring their own laptops. The organisers will provide power outlets in the room and possibly extension cords. The set-up will allow participants to share one screen during the practical exercises.