From a8539b6eba80e67ad8a9fa5bb5cead03fd4b1aa0 Mon Sep 17 00:00:00 2001 From: Alexander Koufos Date: Sun, 16 Mar 2025 20:01:33 -0700 Subject: [PATCH 1/3] Adds start of code review demo event - Adds an event for the upcoming code review demo series event --- ...025-03-code-review-demo-reproducibility.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 _events/2025/2025-03-code-review-demo-reproducibility.md diff --git a/_events/2025/2025-03-code-review-demo-reproducibility.md b/_events/2025/2025-03-code-review-demo-reproducibility.md new file mode 100644 index 000000000..2d3129b53 --- /dev/null +++ b/_events/2025/2025-03-code-review-demo-reproducibility.md @@ -0,0 +1,25 @@ +--- +title: Code Review Demo - Reproducibility Audit +excerpt_separator: +expires: 2025-03-27 +event_date: "March 27, 2025" +layout: event +duration: 60 +repeated: false +category: community-learning +address: +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 + + +#### 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? 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”. \ No newline at end of file From a7c2c7ad36157ec3846f1461b1c843032e686924 Mon Sep 17 00:00:00 2001 From: Alexander Koufos Date: Mon, 17 Mar 2025 12:49:58 -0700 Subject: [PATCH 2/3] Adds upcoming code review demo event - Adds the March Code Review Demo event to event page and calendar --- .../2025-03-code-review-demo-reproducibility.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/_events/2025/2025-03-code-review-demo-reproducibility.md b/_events/2025/2025-03-code-review-demo-reproducibility.md index 2d3129b53..e21e951b2 100644 --- a/_events/2025/2025-03-code-review-demo-reproducibility.md +++ b/_events/2025/2025-03-code-review-demo-reproducibility.md @@ -7,13 +7,16 @@ layout: event duration: 60 repeated: false category: community-learning -address: 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 +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 + #### Title @@ -22,4 +25,12 @@ 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? 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”. \ No newline at end of file +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? +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”. \ No newline at end of file From 409250266b20ad97c0db602a4349475ceb3f7c80 Mon Sep 17 00:00:00 2001 From: Alexander Koufos Date: Mon, 17 Mar 2025 13:14:03 -0700 Subject: [PATCH 3/3] Updates Code Review WG page - Updates chairs - Updates formatting between some headers - Adds resources - Removes "Work Products" header --- pages/wg/code-review.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/pages/wg/code-review.md b/pages/wg/code-review.md index 3a1a50428..fba518b3d 100644 --- a/pages/wg/code-review.md +++ b/pages/wg/code-review.md @@ -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 +
-## Code Review Resources +# Code Review Resources -### Code Review Tutorials and Good Practices +
-- [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 +
+ +# Volunteer Opportunities - [rOpenSci](https://ropensci.org/software-review) - [pyOpenSci](https://www.pyopensci.org/)