Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/wg cr chairs event resources #1686

Merged
merged 3 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions _events/2025/2025-03-code-review-demo-reproducibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Code Review Demo - Reproducibility Audit
excerpt_separator: <!--more-->
expires: 2025-03-27
event_date: "March 27, 2025"
layout: event
duration: 60
repeated: false
category: community-learning
time:
- - start: 2025-03-27T19:00:00Z
end: 2025-03-27T20:00:00Z
---

Join us for the first demo of the US-RSE's Code Review Working Group's "Code
Review Demo Series".
Our first demo will be on "Reproducibility Audits" presented by Eric Scott.
Please register for the event at
<https://arizona.zoom.us/meeting/register/TBDaXBUVT-evkLNR83bReg#/registration>

<!--more-->
#### Title

Code Review Demo: Reproducibility Audits

#### Description

This is the first in a series of code review demos hosted by the US-RSE code
review working group.
In this demo, we will discuss reproducibility audits, a broad (and shallow)
type of code review focused on the following questions: Can I figure out how to
get the code to run?
Comment on lines +30 to +32
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line breaks are weird here (I know, it doesn't matter)

Suggested change
In this demo, we will discuss reproducibility audits, a broad (and shallow)
type of code review focused on the following questions: Can I figure out how to
get the code to run?
In this demo, we will discuss reproducibility audits, a broad (and shallow) type of code review focused on the following questions:
Can I figure out how to get the code to run?

Does the code produce the expected outputs?
How readable and re-usable is the code?
This type of code review can be useful before submitting a manuscript with
associated analysis code, or in the context of a “ReproHack”.
26 changes: 18 additions & 8 deletions pages/wg/code-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,31 +23,41 @@ To get involved, visit the
[`#wg-code-review`](https://usrse.slack.com/messages/wg-code-review) channel
on the US-RSE slack.

**Co-Chairs**: Jeffrey Carver, Troy Comi
**Co-Chairs**: Jeffrey Carver, Alex Koufos, Abbey Roelofs

# Work Products
<hr class="my-5">

## Code Review Resources
# Code Review Resources

### Code Review Tutorials and Good Practices
<hr class="w-50">

- [code-review.org](https://code-review.org/)
## Code Review Tutorials and Good Practices

- [code-review.org (tutorial)](https://code-review.org/)
- [Tidyteam code review principles](https://code-review.tidyverse.org/)
- [Code review training module](https://intersect-training.org/Code-Review/)
- ["How to do Code Reviews Like a Human"](https://www.youtube.com/watch?v=0t4_MfHgb_A) (lecture recording)
- ["Contemporary Peer Code Review Practices in Research Software"](https://carver.cs.ua.edu/Slides/2019/CodeReviewTutorial/TutorialSlides.pdf) (slides)
- ["Code Review Views" (slides)](https://drive.google.com/file/d/1qszIciQ2RWVYK1fzxk1XI7QkOJcHsWuB/view)
- [Stanford Health Policy Data Science - "Code Review"](https://stanfordhpds.github.io/lab_manual/chapters/08-code-review.html)
- [rOpenSci - "Guide for Reviewers"](https://devguide.ropensci.org/softwarereview_reviewer.html)
- [Code for Thought - "Planning your research software - a workshop in Paris" (podcast)](https://play.pocketcasts.com/podcasts/7eedc800-37ef-0139-3323-0acc26574db2/d2238833-2777-4693-a958-dbddabac0c7e?t=1973)
- [Lab Handbooks (collection)](https://github.com/cct-datascience/open-lab-handbooks?tab=readme-ov-file)
- [Ecological Forecasting Initiative (collection)](https://ecoforecast.org/resources-for-reviewing-code/)

### Automated Code Review Tools
## Automated Code Review Tools

- [Repo-Review](https://learn.scientific-python.org/development/guides/repo-review/)
- [Codefair](https://github.com/fairdataihub/codefair-app)

### Code Review Anxiety
## Code Review Anxiety

- [Understanding and Effectively Mitigating Code Review Anxiety](https://osf.io/preprints/psyarxiv/8k5a4)
- [The Code Review Anxiety Workbook](https://developer-success-lab.gitbook.io/code-review-anxiety-workbook-1)

## Volunteer Opportunities
<hr class="my-5">

# Volunteer Opportunities

- [rOpenSci](https://ropensci.org/software-review)
- [pyOpenSci](https://www.pyopensci.org/)
Expand Down