-
-
Notifications
You must be signed in to change notification settings - Fork 115
Added Code Review Guide for issue #429 #1624
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.
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
Added Code Review Guide for issue #429 #1624
Conversation
👷 Deploy request for cyf-curriculum pending review.Visit the deploys page to approve it
|
👷 Deploy request for cyf-piscine pending review.Visit the deploys page to approve it
|
👷 Deploy request for cyf-launch pending review.Visit the deploys page to approve it
|
👷 Deploy request for cyf-sdc pending review.Visit the deploys page to approve it
|
👷 Deploy request for cyf-itd pending review.Visit the deploys page to approve it
|
👷 Deploy request for cyf-tracks pending review.Visit the deploys page to approve it
|
👷 Deploy request for cyf-common pending review.Visit the deploys page to approve it
|
|
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? |
illicitonion
left a comment
There was a problem hiding this 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!
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