Code review in your team

Open
#16 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
git, github, vscode
Domain
documentation

Research direction

Start with the linked GitHub pull request review guide, then open a teammate's PR in GitHub or VS Code; optionally check it out locally with gh pr checkout 123 and run it. Review against the ticket's acceptance criteria, ask questions, suggest improvements, and submit the review on the teammate's PR.

Written by the indexing model from the issue text.

Description

🎯 Topic Code Review 🎯 Topic Teamwork πŸ• Priority Mandatory πŸ‚ Size Medium πŸ“… Week 2 πŸ“… Week 3 πŸ“… Week 4 πŸ“… Week 5 Recurring
Link to the coursework

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews

Why are we doing this?

You must set aside a part of your development time to review the work of your team. In technical interviews, you may to asked to discuss a feature written by someone else in your team, so you will need to read and understand it.

How to review

  • Use the GitHub PR interface, either on GitHub or via VSCode
  • Checkout the PR locally gh pr checkout 123 and run the code to make sure it works
  • Test the code using the acceptance criteria on the ticket
  • Ask clarifying questions to make sure you understand the code
  • Offer any fixes or improvements you can see
Maximum time in hours

2

How to get help

Volunteers and other team members can help you with code review. You may choose to spend some time in class doing this together.

How to submit

Submit your review directly on your teammates PR.

Dominant language
No language data
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up β€” it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CodeYourFuture/Module-The-Launch

All issues in CodeYourFuture/Module-The-Launch

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.