charvibannur / Getting-Started

A guide to making your first open-source contribution !

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WELCOME TO TECH-MATRIX ! 🎉

We're so glad you found yourselves here!

The current iteration of Tech-Matrix has two subdivisions :

📌 Open Source September

A 4-week odyssey of learning and hands-on contribution for beginners to start their open-source journey !

What's in store:

Open_Source_September_Schedule

Making Your First Contribution

First off, if you don't have git set up on your machine, install it here.
Once that's done, come back here and follow these steps !

1. Fork this repository

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

2. Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon to copy the url of the repo.
image

Open your terminal and run the following git command:

git clone <url you just copied>

For example:

git clone https://github.com/A-HK/Getting-Started-1.git

Remember to clone your forked repository , not the original one.

3. Create a branch

Change to the repository directory on your computer (if you are not already there):

cd Getting-Started

Now create a branch using the git checkout command:

git checkout -b your-new-branch-name

For example:

git checkout -b A-HK-first-contrib

4. Add the necessary details

Woohoo! You're almost there! Open the contributors-list.md file and add your name and a little about yourself !
image

5. Commit your changes

If you go to the project directory and execute the command git status in the terminal, you'll see there are changes.
Add the changed files to the branch you just created using the git add command:

git add contributors-list.md

Now commit those changes using the git commit command:

git commit -m "your message"

For example:

git commit -m "added A-HK details to contributors list"

6. Push your changes to GitHub

Push your changes using the command git push:

git push origin <add-your-branch-name>

For example:

git push origin A-HK-first-contrib

7. Submit your Pull request for review

image

Go to your forked repository on GitHub and click on the Compare & pull request button.

image

Submit your Pull Request, after ensuring that the base repository is Tech-Matrix/Getting-Started and head repository is <your-username>/Getting-Started

image



✨Congrats ! You just made a contribution ! ✨

All you have to do now is sit tight and wait for us to merge your PR :)

About

A guide to making your first open-source contribution !