Skip to content

Conversation

@konaspandana017
Copy link

@konaspandana017 konaspandana017 commented Oct 26, 2025

Summary
Added a new Code Review Guide under common-docs/code-review-guide.md that complements existing CodeYourFuture reviewing guides.

Related Issue
Closes #429 — “Write / Build Code review guide/site/app/video/something”

Details
This guide helps trainees and contributors understand how to review code effectively. It includes:

Purpose and importance of code reviews

Step-by-step process for reviewing code

Example review comments

Links to useful resources and existing CodeYourFuture guides

Checklist for reviewers

Related Guides

CodeYourFuture Reviewing Guide

@netlify
Copy link

netlify bot commented Oct 26, 2025

👷 Deploy request for cyf-curriculum pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 6ea22a8

@netlify
Copy link

netlify bot commented Oct 26, 2025

👷 Deploy request for cyf-piscine pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 6ea22a8

@netlify
Copy link

netlify bot commented Oct 26, 2025

👷 Deploy request for cyf-launch pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 6ea22a8

@netlify
Copy link

netlify bot commented Oct 26, 2025

👷 Deploy request for cyf-sdc pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 6ea22a8

@netlify
Copy link

netlify bot commented Oct 26, 2025

👷 Deploy request for cyf-itd pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 6ea22a8

@netlify
Copy link

netlify bot commented Oct 26, 2025

👷 Deploy request for cyf-tracks pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 6ea22a8

@netlify
Copy link

netlify bot commented Oct 26, 2025

👷 Deploy request for cyf-common pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 6ea22a8

@cjyuan
Copy link
Contributor

cjyuan commented Oct 27, 2025

These are useful advice. Some of the points might have already been covered in the "Code Review Guide" and "Things to look for in a code review":

You can view the corresponding rendered pages on

Can you help integrate your guide with the existing guides?

Copy link
Member

@illicitonion illicitonion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for looking at this!

I think we'd rather improve the existing guides (by making edits to the existing files in https://github.com/CodeYourFuture/curriculum/tree/main/org-cyf-guides/content/reviewing) rather than adding new guides.

Please can you take a look at the existing guides and see if there are any edits you want to suggest to them, rather than writing another page with copies of some of the same ideas?

Thank you!

@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Curriculum Planning Nov 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Write / Build Code review guide/site/app/video/something

3 participants