Code review in pull requests in Git - Mini Project: Build & Apply

Code Review in Pull Requests

📖 Scenario: You are working on a team project using Git and GitHub. Your team uses pull requests to review code changes before merging them into the main branch. This helps catch mistakes early and keeps the project quality high.

🎯 Goal: You will create a new branch, make a simple code change, push it to GitHub, open a pull request, and simulate a code review comment. This will teach you the basic workflow of code review in pull requests.

📋 What You'll Learn

Create a new branch called feature/update-readme

Make a change to the README.md file by adding the line Updated project description.

Commit the change with the message Update README with new description

Push the branch feature/update-readme to the remote repository

Simulate opening a pull request from feature/update-readme to main

Simulate adding a code review comment on the pull request

💡 Why This Matters

🌍 Real World

Teams use pull requests to review code changes before merging, which helps catch errors and improve code quality.

💼 Career

Understanding pull requests and code reviews is essential for collaboration in software development jobs.

1

Create a new branch called feature/update-readme

Use the command git checkout -b feature/update-readme to create and switch to the new branch.

Git

# Use git checkout -b feature/update-readme to create and switch to the new branch
# Your code here

Need a hint?

Think of a branch as a separate workspace. The command git checkout -b creates and switches to it in one step.

2

Add a line to README.md file

Add the exact line Updated project description. to the README.md file using a command like echo or by editing the file.

Git

git checkout -b feature/update-readme
# Add the line 'Updated project description.' to README.md
# Your code here

Need a hint?

You can add text to a file by using echo 'text' >> filename. The double greater-than sign appends the text.

3

Commit the change with message Update README with new description

Use git add README.md to stage the file, then commit with git commit -m "Update README with new description".

Git

git checkout -b feature/update-readme

echo 'Updated project description.' >> README.md
# Stage README.md and commit with the exact message
# Your code here

Need a hint?

First stage your changes with git add, then save them with git commit -m "message".

4

Push the branch and simulate opening a pull request

Push the branch with git push origin feature/update-readme. Then simulate opening a pull request by writing a comment: Open pull request from feature/update-readme to main.

Git

git checkout -b feature/update-readme

echo 'Updated project description.' >> README.md

git add README.md

git commit -m "Update README with new description"
# Push the branch and simulate opening a pull request
# Your code here

Need a hint?

Use git push origin branch-name to send your branch to GitHub. Opening a pull request is usually done on GitHub website, but here you simulate it by writing a comment.

5

Simulate adding a code review comment on the pull request

Write a comment simulating a code review: Review comment: Please add more details to the README update.

Git

git checkout -b feature/update-readme

echo 'Updated project description.' >> README.md

git add README.md

git commit -m "Update README with new description"

git push origin feature/update-readme

# Open pull request from feature/update-readme to main
# Your code here

Need a hint?

Code reviews help improve code quality. Here you practice by writing a review comment as a line starting with # Review comment:.