Giter Club home page Giter Club logo

bitmcontributions's Introduction

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 HacktoberFest_19 by using the Fork button or clicking this at top-right of your screen.

Fork Button

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 HacktoberFest_19 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 HacktoberFest_19
$ cd BITMcontribution

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 :octocat:

$ 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 `HacktoberFest_19` 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 contributors

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 Folder_Name

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)

bitmcontributions's People

Contributors

greyhatlinux avatar risheekjain avatar sk99sk avatar utkarsh0407 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.