Hey friend! π
Welcome to this repository which marks your start in the Open Source World!! ππ―ββοΈ
In the next 10 min, you will contribute to your first Open Source projects - how crazyyy is that. π
Now when contributing, we want to:
1. fork -> 2. clone -> 3. edit -> 4. push -> 5. pull
- Fork β‘οΈ Make a copy of the project on your GitHub account
- Clone β‘οΈ Download the project from GitHub to your computer
- Edit β‘οΈ That's self-explanatory - here you will add your name to our contributors file
- Push β‘οΈ Update and send the changes to your online GitHub repository
- Pull β‘οΈ Send your contribution to the original GitHub repository
That may sound a bit intimidating, but don't worry I got you! π―ββοΈ
Also if you are wondering: YES, this is exactly how all the devs in the world contribute to software projects online!
So in this project, you will have a great understanding of the mechanics behind GitHub so that you are ready for your future contributions!
You reeeeeady?? Let's do it - we got this βοΈπ«Ά
Requirement: If not already done, download Git here.
First, click on βοΈ star
in the right corner (to show some love π«ΆπββοΈ) and then click on the fork
button.
Fork means you will create a copy of this repository in your own GitHub account. πͺ
Now that you have the copy on your own account, let's download the entire project on your local computer!
1οΈβ£ You should now have landed on your forked repo page, here you will see a <>
button marked in green, click on it.
2οΈβ£ Click on the button looking like a double square
(highlighted in red below) to copy the URL.
3οΈβ£ Open your terminal.
4οΈβ£ Use your terminal to move to a folder where you want to put the cloned project (using more technical language, this is called moving to a directory of your choice). π
5οΈβ£ Type git clone
and then paste the URL copied earlier.
You normally should have written
git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
6οΈβ£ Press Enter.
The entire project is now on your computer!
1οΈβ£ On your terminal, make sure that you are in the project (or directory π) by running: cd Your-First-Contribution
.
2οΈβ£ Open the QuineContributors.md
file in a text editor or on your favourite IDE (aka VS Code, Atom, PyCharm, Sublime etc).
Here you add your name (it can be a nickname if you want to!).
3οΈβ£ Copy the below code and adjust it accordingly:
<td align="center">
<a href="https://github.com/YOURUSERNAME">
<sub><b>YOUR NAME</b></sub>
<br />
</a>
</td>
*Note: We limit 8 profiles per row, so if the current row already has the maximum amount, create a new <tr> YOUR CODE SNIPPET HERE </tr>
.
4οΈβ£ When done, save the file!
OK, we got some changes done, now we need to upload them to your GitHub account.
In summary here we want to:
- β add all the changes onto git
- π¬ add a commit message (which helps tell other devs what you have changed) and
- πΎ push the changes to your online GitHub repository.
1οΈβ£ So in your terminal, run the following command: git add .
2οΈβ£ After that, run: git commit -m "description of what you changed/added"
3οΈβ£ Finally, run: git push
At this point, if this is your first time, GitHub will ask you to authenticate yourself with your username and password. π
4οΈβ£ Write out your GitHub username first and press Enter.
5οΈβ£ For your password, ever since Aug 2021, it is a personal token you need to write (and not your actual password!). Don't worry though, let's get your token together by following the below: βΊ
-
On your GitHub account, hover to the top right of the page and click on your profile image
-
Now click on
profile setting
-
Find and Click on
developer setting
-
Click on
Personal Access Tokens (Token Classic)
-
Click on
Generate new token (classic)
-
Give a name e.g "authentification token"
At this point, you should be here β¬οΈ:
6οΈβ£ Select the scopes you want (for ease you can select all of them).
7οΈβ£ Click on Generate token
8οΈβ£ Your token will be displayed and you will be able to paste it into your terminal after which your push should have been successful! π
We are so close to the end now! π€
All we need to do is now send over our changes to the original repository to make our contribution.
In "GitHub language", this is called "pulling a request" because you essentially "pull" your changes into the original repository that you forked.
1οΈβ£ Go now to your GitHub repo page online.
2οΈβ£ Click on the Contribute
button.
3οΈβ£ Click on Open pull request
4οΈβ£ You will then title your pull request with your "Name Surname" and you can leave the comment section blank.
5οΈβ£ Click Create pull request
and that's it you have made your first contribution!! ππ―ββοΈ
Congraaaaaaaats! βοΈ
You may be thinking, I thought I would be taken to the repository straight away but I'm left with the status of the pull request?
YES, this is because we now need to accept your pull request (it is also called merging a pull request).
All in all, contributions happen in this way where the maintainer(s) of the original repository (aka the people that are in charge of the repo) check your contributions and either end up accepting them or giving you feedback on what changes they need from you.
So sit back and relax as you have just done everything you needed! βοΈπ§ββοΈπ
We know it is always super tough the first time and it's really cool you got to this point - so proud of you! π―ββοΈπ
If you are ready to start contributing to other projects, we have compiled a list of projects with easy issues you can get started on. Check out the list of projects on quine.shπ
If you haven't yet, you could join our discord team if you need any help or have any questions. π«Ά