Skip to content

Latest commit

 

History

History
198 lines (129 loc) · 6.42 KB

README.md

File metadata and controls

198 lines (129 loc) · 6.42 KB
Raw

Gitter

Welcome to Algorithm and Data Structure Notes 📋

Our open source community is focussed on understanding the concepts and while doing so, whenever someone gets trapped, they can see one way to code in any language they want. So, we are developing a repository having implementation in as many languages as we can.

Index

Steps to follow 📜

1. Fork it 🍴

You can get your own fork/copy of Algo_Ds_Notes by using the Fork button or clicking this.

Fork Button

2. Clone it 👥

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

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

This makes a local copy of repository in your machine.

Once you have cloned the Algo_Ds_Notes repository in Github, move to that folder first using change directory command on linux and Mac.

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

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/Algo_Ds_Notes.git (fetch)
origin  https://github.com/Your_Username/Algo_Ds_Notes.git (push)

Now, lets add a reference to the original Algo_Ds_Notes repository using

$ git remote add upstream https://github.com/jainaman224/Algo_Ds_Notes.git

This adds a new remote named upstream.

See the changes using

$ git remote -v
origin    https://github.com/Your_Username/Algo_Ds_Notes.git (fetch)
origin    https://github.com/Your_Username/Algo_Ds_Notes.git (push)
upstream  https://github.com/jainaman224/Algo_Ds_Notes.git (fetch)
upstream  https://github.com/jainaman224/Algo_Ds_Notes.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 `Algo_Ds_Notes` 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 Folder_Name

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

To switch to desired branch

# To switch from one folder to other
$ git checkout Folder_Name

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 effort.

Help Contributing Guides 👑

We love to have articles and codes in different languages and betterment of existing ones.

Please discuss it with us first by creating new issue.

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉

Code Maintainers 😎

CoffeeScript

jainaman224

Cplusplus

AnkitaKhurana KavyaSharma nj4710 sidgorey uday1201

CSharp

AnkitaKhurana nihalC07

Java

adishjain KavyaSharma nj4710 ayushin78

JavaScript

prakharcode

Markdown

swatinirwal

Php

MehakJain96 nihalC07 swatinirwal

Python

jainaman224

Ruby

tnarkiv

References 📋 📜

  • Books 📖 📚
    • Data Structures with C by Schaum Series
    • Data Structures: A Pseudocode Approach with C by Richard F. Gilberg
    • Fundamentals Of Data Structures in C by Horowitz
    • Introduction To Algorithms By Thomas H. Cormen
    • Java: The Complete Reference By Herbert Schildt
    • Object Oriented Programming with C++ by E Balaguruswamy
  • Websites 💻