Elektrine lite

โ† Feed

@ngaylinn@tech.lgbt

2025-02-03 22:32 UTC

Has anyone ever seen code reviews working well in an academic setting? One of my lab mates just paid a very high price for a small bug, and we're talking about using code reviews to prevent this. Coming from industry myself, I like this idea and volunteered to help figure this out, but I can also imagine lots of reasons this might not work in a lab full of grad students and postdocs. In particular, I'm worried about training people to actually give good code reviews, sharing the workload fairly, and agreeing on a standard for code quality. I'm very familiar with how to deal with those issues on a software engineering team, but they would all be very different in this setting... #academicchatter #computerscience #compsci

Replies (6)

  • @ngaylinn@tech.lgbt I don't have direct experience but I'd look to @gvwilson@fosstodon.org, @thecarpentries@hachyderm.io, Software.ac.uk, and https://book.the-turing-way.org/

    Open ##2733464

  • @jonclayden@mastodon.online 2025-02-04 14:18

    @ngaylinn@tech.lgbt We don't do code reviews internally, but I've been involved with reviewing for @rOpenSci@hachyderm.io, which was well thought-through and constructive (https://ropensci.org/software-review/). A slightly different scenario, perhaps, but worth looking at on standards, procedures, etc.

    Open ##2733491

  • @HeidiSeibold@fosstodon.org 2025-02-04 14:46

    @ngaylinn@tech.lgbt I wrote a newsletter post about exactly this topic. Maybe this helps ๐Ÿ˜‰ https://heidiseibold.kit.com/posts/code-clubs-good-coding-practices-for-all Thanks @da5nsy@social.coop for making me aware of this discussion ๐Ÿ‘

    Open ##2733492

  • @joeroe@archaeo.social 2025-02-04 16:06

    @ngaylinn@tech.lgbt Yes, and it works well, but then we're a (very) small team and all happen to have some background in software engineering. If I were to integrate software reviews into a more typical lab, I'd say they'd have to fit to the different structures of academia (i.e. where your PI is or should an expert in what you're doing, not an expert in management). So the PI or other senior person in charge of supervising graduate students or postdocs should be reviewing code, as they likely do papers.

    Open ##2733505

  • @ngaylinn@tech.lgbt This is something I'm very interested in and I think collecting and sharing case studies like what happened to your lab mate is a big piece of getting buy-in from academics. We've got a code-review working group at @us_rse@fosstodon.org and part of what we discuss is how to get lab groups to do peer code review. Would love to have you join the discussion!

    Open ##2733506

  • @nrennie@fosstodon.org 2025-02-04 18:10

    @ngaylinn@tech.lgbt I recently ran a workshop for PhD students and postdocs on writing better code (aiming to write code that is easier to share with other people) and we did a session on GitHub and code review as part of that. My resources are here if they are helpful: https://nrennie.rbind.io/training-better-r-code/ and https://nrennie.rbind.io/training-git-r/ This blog post by @_jcken@qoto.org also has a lot of good advice that's very relevant for code review in academia: https://jcken95.github.io/projects/code_review.html

    Open ##2733507