Skip to content

Commit

Permalink
Merge pull request #86 from GusStgoReyes/patch-1
Browse files Browse the repository at this point in the history
Update code_management.md with code review description
  • Loading branch information
poldrack authored Feb 4, 2025
2 parents 5dc6b7c + 64c13f8 commit dceb22d
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions labguide/research/code_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit dceb22d

Please sign in to comment.