BITMcontributions 🏢

It's always hard the first time you do something. Especially when you are collaborating, making mistakes isn't a comfortable thing. We wanted to simplify the way new open-source contributors learn & contribute for the first time. This repo will take you from the very scratch to fianlly contributing to the open source.

Steps to follow ⏩

0. Star The Repo 🌟

Star the repo by pressing the topmost-right button to start your wonderful journey.

1. Fork it 🍴

You can get your own fork/copy of BITMcontributions by using the Fork button or clicking this at top-right of your screen.

2. Clone it 👥

NOTE: commands are to be exceuted on Linux, Mac and Windows(using Powershell)

You need to clone (download) it to local machine using

$ git clone https://github.com/Your_Username/BITMcontributions.git

This makes a local copy of repository in your machine.

Once you have cloned the BITMcontributions repository in Github, move to that folder first using change directory command on Linux, Mac and Windows(powershell to be used).

# This will change directory to a folder BITMcontributions
$ cd BITMcontributions

Move to this folder for all other commands.

3. Set it up ⬆️

Run the following commands to see that your local copy has a reference to your forked remote repository in Github

$ git remote -v
origin  https://github.com/Your_Username/BITMcontributions.git (fetch)
origin  https://github.com/Your_Username/BITMcontributions.git (push)

Now, lets add a reference to the original BITMcontributions](https://github.com/greyhatlinux/BITMcontributions/) repository using

$ git remote add upstream https://github.com/greyhatlinux/BITMcontributions.git

This adds a new remote named upstream.

See the changes using

$ git remote -v
origin    https://github.com/Your_Username/BITMcontributions.git(fetch)
origin    https://github.com/Your_Username/BITMcontributions.git (push)

In your ase you will see

$ git remote -V
upstream  https://github.com/greyhatlinux/BITMcontributions.git (fetch)
upstream  https://github.com/greyhatlinux/BITMcontributions.git (push)

4. Sync it ♻️

Always keep your local copy of repository updated with the original repository. Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.

# Fetch all remote repositories and delete any deleted remote branches
$ git fetch --all --prune

# Switch to `master` branch
$ git checkout master

# Reset local `master` branch to match `upstream` repository's `master` branch
$ git reset --hard upstream/master

# Push changes to your forked `BITMcontributions` repo
$ git push origin master

5. Ready Steady Go... 🐢 🐇

Once you have completed these steps, you are ready to start contributing by checking our Help Wanted Issues and creating pull requests.

6. Create a new branch ‼️

Whenever you are going to make contribution. Please create seperate branch using command and keep your master branch clean (i.e. synced with remote branch).

# It will create a new branch with name Branch_Name and switch to branch Folder_Name
$ git checkout -b contributor

Create a seperate branch for contibution and try to use same name of branch as of folder.

Add your contribution and save in the editor.

To add the changes to the branch. Use

# To add all files to branch Folder_Name
$ git add .

Type in a message relevant for the code reveiwer using

# This message get associated with all files you have changed
$ git commit -m 'relevant message'

Now, Push your awesome work to your remote repository using

# To push your work to your remote repository
$ git push -u origin contributor

Finally, go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your precious efforts.

What to contribute ❓

After making a branch with your username, checkout your branch. Create a file <your_username>.md.

In the file put in your Name, Branch and Institution, and finally your interests/hobbies. Or simply copy paste the following section of code and edit it with your details. (You can put your GitHub or LinkedIn profile link in the portfolio if you don/t have one)

Format :

# Vishal Gorai

## Academics: 
#### Pursuing B.Tech in Electronics and Communication Engineering
#### Birla Institute of Technology, Mesra

### Interests : 
- Web Development
- Software Engineering
- Networking and Cyber Security
- Embedded Systems

### Portfolio :
[vishalgorai.cf](http://vishalgorai.cf)