Skip to content

Update code_management.md with code review description #86

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.

Sign up for GitHub

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

Merged
poldrack merged 1 commit into from
Feb 4, 2025
Merged

Update code_management.md with code review description #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions labguide/research/code_management.md
View file
Open in desktop
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
Loading