π₯
OSS-Contribution Learn how to contribute to open-source projects.
You'll learn the git workflow required to contribute to open-source projects.
For git basics & tips & tricks - click me!
π Go to the end of the file to see who contributed!
WHAT ARE YOU GOING TO LEARN
- The git workflow required for working on open-source projects
- Working in a team
WHAT ARE YOU NOT GOING TO LEARN
- How to use git
- How to code
π΄
STEP 1 - FORK THIS REPOSITORY Fork this repository by clicking on the fork button.
When you fork a repository, you simply create a copy the repo on your account.
ποΈ
STEP 2 - CLONE THE REPO The next step is to clone the repository to your machine, so you can make changes.
To do so, go into the repo you just forked into your account, then click the button called Clone or download.
Copy the link, and run this in your terminal:
git clone <the-url-you-just-copied>
In my case, it would be:
git clone https://github.com/catalinpit/OSS-Contribution.git
In your case, you would replace catalinpit with your username.
STEP 3 - CREATE A BRANCH π²
First of all, open the repository in your editor.
Then, create a branch as follows:
git checkout -b <enter-your-branch-name>
An example would be:
git checkout -b "Added_My_Name_To_README"
The name of your branch should be short and descriptive. The branch above is just an example, but it can be called however you want.
It should describe the purpose of your changes though. I chose that name because I added my name to the README (what you'll do as well).
βοΈ
STEP 4 - MAKE YOUR CHANGES - Open the file called
README.md
- Find the CONTRIBUTORS section.
-
Add your name RANDOMLY in the list to avoid merge conflicts
Once you have added your name and Twitter handle, run in your terminal:
-
git add README.md
(it represents the file where you made the change) -
git commit -m "Added my name and twitter handle"
(this represent the message that explains what you did) -
git push origin <your-branch-name>
(push your changes to Github)
STEP 5 - OPEN A PULL REQUEST (PR) π
The purpose of a pull request is to show to other developers the changes you did.
Also, they review your code to make sure your code is optimal.
- Once you pushed your changes to Github, go to the repo and click on
Compare & pull request
.
- Add a descriptive title and description
-
Click on
Create pull request
. -
Wait for me to merge your changes to the master change. They will become live once I merge them.
Congratulations! This is the required Git workflow to contribute to open source projects.
EXTRA TIPS
Go over my repos, and if you see any typos & programming bugs/errors, open a PR. π₯³
π§βπ€βπ§
CONTRIBUTORS Add your name and Twitter handle.
- Piyush Patilππ‘ => Twitter: @Piyush67372814
π¦ - Catalin Pit
π π‘ => Twitter: @catalinmpitπ¦ - Vikas Ganiga
π π‘ => Twitter: @vikasganiga05 π¦ - Max Diamond
π€ π => Twitter: @dmdboiπ¦ - Collins Cheruiyot
π» π‘ => Twitter: @cherucoleβοΈ - Ashish Mishra
π» π‘ => Twitter: @Mr_AshishM π - Eddy Vinck
π π‘ => Twitter: @veinq_ π¦ - Oteri Eyenike
π π‘ => Twitter: @codeg0d π¦ - Danny Wolff ππ‘ => Twitter: @Inshi78946780
π¦ - Josh Javier π³β => Twitter: @joshjavierr
- Jaspar Ifesinachi π₯π‘ => Twiter: @ifeabasi
π₯ π - Minerva Long
π π‘ => Twitter: @vanesa_minervaπ¦ - Benjamin Kinga ππ‘ => Twitter: @benjaminkinga1
π¦ - Prajwal Poojary
π₯ π => Twitter: @prajwalbpoojary π¦ - Samson Samuel
π π‘ => Twitter: @torsami77π¦ - Mahesh Jamdade
π π‘ => Twitter: @maheshmnj π - Kenny John Jacob
π π‘ => Twitter: @johnjacobkennyπ₯ - Omar Estrada ππ‘ => Twitter: @ConceptsCurious
π¦ - Waheed Afolabi ππ‘ => Twitter: @checkwithwaheed
π¦ - Milos Rancic
π π‘ => Twitter: @milos_rancicπ¦ - Stefanie Davis
π π‘ => Twitter:@steflikecurry βπΎ - Tharun Reddy ππ‘=> Twitter: @tharun
π¦ - Lawrence Narh-Lawson
π π‘ => Twitter: @NarhLawsonπ¦ - Ishaan Sheikh
π π‘ => Twitter: @imishaan005π¦ - Omolewa Stephen
π π‘ => Twitter: @theslimsteveπ¦ - Cory Runnells ππ‘=> Twitter: @XRayBound
π¦ - Wasif Baliyan
π π‘ => Twitter: @wasifbaliyan - Saif Ullah Sajid
π π‘ => Twitter: @saifcodesπ¦ - Matthew Terrill => Twitter: @meterrill
π¦ - Alex Sartori
β => Twitter: @alex__sartori π¦ - Dowen Robinson
π π‘ => Twitter @yuhmaddaπ¦ - Tabitha O'Melay => Twitter: @tabby__katz
- Fumi Adeyemi ππ‘ => Twitter @fumiadeyemiπ¦
- Tolulope Adetula ππ‘ => Twitter @_tolu_lope
π¦ - Raviq Lahadi
π₯ π‘ => Twitter: @raviqlahadiπΈ - Stefan Natter
π π‘ => Twitter @natterstefanπ¦ - Christina Meador
π π‘ => Twitter @ChristinaM_Devπ¦ - Jeremy Nikolic ππ‘ => Twitter @jeremy__nikolic
π - Kabir Nazir
π π‘ => Twitter: @kabir4691 π¦ - Vasantha Kumar
π π‘ => Twitter: @Vasantha_KumarJ - Tony Phan
π π‘ => Twitter: @rallysport206π¦ - JerΓ³nimo CosiΓo
π π‘ => Twitter: @jerocosioπ¦ - Oluwapelumi Amuzu ππ‘ => Twitter: @livingArete
π¦ - Terry L Sanders => Twitter: @Joeybtfsplk
- Alexandra Caulea
π π‘ => Twitter: @alexandracauleaπ¦ - Philippus Schindler
π π‘ => Twitter: @phil_on91π - Sobhy => Twitter: @ThisIsSobhy
- Cynthia Spence => Twitter: @Cynthia47337663
- Unai =>
π π‘ => Twitter: @unaizuluagaπ¦ - Patrick Odeke ππ => Twitter: @odkpatrick
πββοΈ - Astrit Malsija => Twitter: @astritmalsija
- Mateusz Wszola
π π‘ => Twitter: @MateuszWszolaπ - Himanshu Jain ππ‘=> Twitter: @being_himan
π¨βπ» - Nichola ππ‘ => Twitter: @nichola___
πΈ - Yasser Tahiri
π π‘ => Twitter: @THyasser1π¦ - Alin Pisica
π₯ π‘ => Twitter: @AlinP25πΈ - Tochukwu Ali
π π‘ => Twitter: @tochukwuali3π - Marco Beier
π₯ π‘ => Twitter: @WridgeuπΈ - Ineza BontΓ©
π π‘ => Twitter:@inezabonteπ - Hendry Khoza
π π‘ => Twitter:@henkhodryzaπ¦ - Kaya Chou-Kudu
π₯ π‘ => Twitter: @Kaya_MooonπΈ - Scott Jellen
π π‘ => Twitter @scottjellenπ - Paolo Urciullo
π’ π±βπ€ => Twitter: @paolo__init__π - Syed Hamza Hoda
π’ π±βπ€π π‘ π - Usman Dan abdullah => Twitter:@UsmanDanAbdull1