This is a small effort to teach you the basics of using GitHub. I'm not an expert myself, but as is the spirit of Open Source, every little contribution counts! I'm sure you'll be able to learn the rest by exploring GitHub on your own.
- How to Fork a project (make your own copy).
- How to Clone a project (download it to your computer).
- How to create an Issue (report a bug or suggest an idea).
- How to Commit changes (save your work).
- How to create a Pull Request (propose your changes to the original project).
- A computer with an active internet connection.
- Git installed on your computer. If you haven't installed it yet, here are some helpful YouTube videos:
- A GitHub Account.
- And that's it!
- Open this project from the link provided or find it on my GitHub profile.
- At the top, you'll see my name followed by the project name. This means the project currently belongs to me.
- Because this is my project, you can't make changes to it directly. Instead, you need to create your own copy. We do this by "Forking" and "Cloning."
- Click the "Fork" button at the top right of the page. Congratulations, you've just created your own copy of the project!
- Now, look for the green "Code" button and click it. You will see a web link. This link is what we'll use to download (or "clone") the project to your computer.
- Open a program called Git Bash on your computer. Copy the command below and paste it into Git Bash. (Note: Sometimes
Ctrl + Vdoesn't work in Git Bash, so you might need to right-click and select "Paste").git clone https://github.com/Sanika2103/good-first-issue.git
- This command downloads the project. When you check your GitHub account, you will now see this project listed under your own name!
- This means it is officially your copy, and you are free to make changes to it.
- Next, let's open the
index.htmlfile in the project. - Don't worry if you don't understand the code inside; it's just an example!
- Click the Edit (pencil icon) button on the file.
- Scroll down until you see this piece of code:
<h3>No:- 1</h3> <h3>Name:- Sanika Patil</h3> <h3>Remark:- Yes!! I learned to Fork, Clone, Commit, and make a Pull Request!!</h3>
- Copy those three lines and paste them right below the last entry.
- Update the information: change the
Noto the next number in the sequence, replace my name with your name, and feel free to write your own remark (or keep the same one)! - This step is just to practice making a change in the code.
- Scroll to the bottom of the page. You will see a box asking you to describe what you changed. Write a short, simple message like:
Added my name to the list. - Click the green "Commit changes" button. (Committing just means saving your changes!)
- Awesome! You've saved your work. However, these changes are only in your copy of the project. To share them with me, you need to ask me to "pull" your changes into the original project.
- To do this, we create a Pull Request.
- Go to the Pull Requests tab at the top of the page and click the green "New pull request" button.
- Write a brief note explaining the changes you made.
- Submit the request! I will review it, and if everything looks good, I will merge it into the main project.
- And just like that, you've learned the basics of Git and GitHub! π
(List of contributors will go here)
You can find me on LinkedIn or Twitter: