KickOff To Open Source

First time open source seems very confusing. Beginners are generally overwhelmed and say "What Is This!?".

So, here's a practise environment for your first contribution :D

Let's Start!

STEP 1: Find The Project You Want To Contribute To

First step for starting open source is obviously, finding an open source project to contribute to!

Either you can go for contributing the project os some open source organisation like fossasia etc.

Or, you can find your projects/issues you want ot work on from these websites.

issuehub.io - A website which helps you find projects/issues based on your required language or issue labels.
Code Triage - Another useful tool for searching issues
Up For Grabs - List of projects with issues that can be resolved by beginners
First Timers Only - A list of issues that are labelled "first-timers-only".
Awesome First Timers PR - A list of awesome beginners-friendly projects.

By now, you must have found your required project/issue.

This is a first timers only repo which can be used to make your first open source contribution. We will write our username and description in the CONTRIBUTORS.md file and make a PR.

Congratulations! you just finished STEP 1

STEP 2: Fork The Repository

Fork this repo by clicking on the fork button on the top of the page. This will create a copy of this repository in your account.

STEP 3: Clone The Repository

Clone this repo to your machine. Go to your GitHub account, click on the clone button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "Copied URL"

STEP 4: Create A Branch

Go to the directory where you cloned the repo.

Create a new branch using git checkout command

git checkout -b <branch-name>

for keeping a standard, let's have the name of branch as username

for example:

git checkout -b MadhavBahlMD

STEP 5: Make Changes! Resolve Issue! Commit Those Changes! Push To GitHub!

Make the necessary changes, commit and push your code to GitHub.

Here, we are adding our username, name and bio in the CONTRIBUTORS.md

To make commit and push changes,

git add .

git commit -m "Add [username] as a contributor"

git push origin <branch name>

STEP 6: Open a Pull Request

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Now submit the pull request!

Soon your changes will be reviewed and the PR will be merged if the changes are legit!

Congrats

You just made your first PR.

Welcome to the world of open source

Additional Details: Keeping your fork synced with original repository

First of all, switch to the master branch, master branch is the main working branch which is supposed to have most updated code!

git checkout master

Now, add original repo's url as a new remote, say original

git remote add original [email protected]:Logic-Xcution/Kickoff-To-Open-Source.git

This is a way of telling git that another version of this project exists in the specified url and we’re calling it original. Once the changes are merged, fetch the new version of original repository.

git fetch original

Now, you need to merge the new revision of my repository into your master branch.

git rebase original/master

Now you can push these changes to your GitHub repo:

git push origin master

Also, since your changes are merged and your repo is updated, the branch you created for your contribution is no longer required and you can delete it!

git branch -d <brach-name>

git push origin --delete <branch-name>

All The Best!

Now you know how to contribute to open source, go ahead champ!

prathamesh99 / kickoff-to-open-source Goto Github PK