AI Hints
Home›Git & GitHub Tutorial›Project: Open Source
Git & GitHub · Lesson 127 of 144

Project: Finding Something to Fix

Your first open source issue.

⏱ 2 min read▶ Video at 2:18:43🎓 Free
Watch this lesson in the Git & GitHub courseWatch on YouTube ↗Full Git & GitHub course

In this project, you'll make a real style of open source contribution, from start to finish. The project is a list of Git tips, owned by an account called octo. Someone has reported a typo, and it's labelled good first issue.

Project: Finding Something to Fix
From the video: Project: Finding Something to Fix
  • A real-style contribution
  • A list of Git tips, owned by octo
  • A typo, labelled good first issue

Before writing any code

Before touching anything, read the issue carefully. Leave a friendly comment, saying you'd like to fix it. Read the contributing guide, to learn the project's rules. Then fork the repository, to get your own copy on GitHub.

  1. Readthe issue
  2. CommentI'd like to fix this
  3. CONTRIBUTING.mdthe project's rules
  4. Forkyour own copy
Before writing any code
From the video: Before writing any code

Clone your fork, add upstream

Now we clone our fork, from sam's account. Inside, we add the original project as upstream, so we can stay in sync. Remote dash v shows both. And we find the typo with git grep. Wirte, instead of write.

git
cd ..
git clone https://github.com/sam/awesome-tips.git
Cloning into 'awesome-tips'...
done.
cd awesome-tips
git remote add upstream https://github.com/octo/awesome-tips.git
git remote -v
origin  https://github.com/sam/awesome-tips.git (fetch)
origin  https://github.com/sam/awesome-tips.git (push)
upstream        https://github.com/octo/awesome-tips.git (fetch)
upstream        https://github.com/octo/awesome-tips.git (push)
git grep -n Wirte
tips.md:2:- Wirte clear messages

Summary

Read the issue, comment, read the guide, fork, clone, and add upstream. Next, making the fix.

Key takeaways
  • Comment on the issue first
  • Fork, then clone
  • Add upstream
Next up: Project: Making the Fix — a branch and a pull request