Merge Request Feedback Style Guide

This guide helps mentors provide clear, actionable feedback on student merge requests. Follow these practices to keep reviews constructive and consistent.

Structure Your Comments

• Summarize the overall impression at the top of the review.
• Use inline comments for specific code suggestions or questions.
• Reference line numbers when describing issues to avoid confusion.
• Link to resources or examples that help the student learn.

Tone and Approach

• Be encouraging. Highlight what was done well before noting improvements.
• Stay specific. Point out the exact function or file where changes are needed.
• Explain why. Provide reasoning so students understand the impact of revisions.
• Ask clarifying questions instead of assuming intent.

Common Feedback Areas

1. Code Style – Refer students to assignments/code_style_guide.md for formatting and docstring standards.
2. Logic and Structure – Suggest alternative approaches if you see bugs or overly complex solutions.
3. Testing – Encourage adding or updating unit tests when functionality changes.
4. Documentation – Remind students to keep README files and inline comments up to date.

Closing Out Reviews

• Approve the merge request once essential issues are addressed.
• If further changes are optional, note them as suggestions rather than blocking items.
• Thank the student for their work and invite follow-up questions in Slack.

Consistent, positive feedback helps interns grow as developers and makes the review process smoother for everyone.