From 64c13f850baa970b5d0f1628998de0a15fd0510c Mon Sep 17 00:00:00 2001 From: Gustavo Santiago-Reyes <117933728+GusStgoReyes@users.noreply.github.com> Date: Tue, 4 Feb 2025 14:25:41 -0800 Subject: [PATCH] Update code_management.md with code review description --- labguide/research/code_management.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/labguide/research/code_management.md b/labguide/research/code_management.md index 3ec5f3f..6a4a10f 100644 --- a/labguide/research/code_management.md +++ b/labguide/research/code_management.md @@ -26,8 +26,15 @@ with and reported to Dr. Poldrack and other relevant parties immediately. ## Code review -- All coding projects should be - reviewed prior to paper submission. +- All coding projects should undergo a review before paper submission. +- When writing code, keep in mind that it will be shared with others. This mindset improves readability and encourages careful development practices. +- At the very least, your code should: + - Be version-controlled and have a straightforward installation process for dependencies. + - Include files that allow for testing. + - Be well-documented (e.g., comments in code) and clearly written. + - Contain a README.md file that explains the structure of your codebase. +- Code review is an ongoing process rather than a final step, so there is no expectation for your code to be "perfect" at any stage. +- Here are some useful resources on code review: (Awesome Code Review)[https://github.com/joho/awesome-code-review], (Blog post)[https://www.djmannion.net/code_review/]. ## Code sharing