Skip to content

Updated readme #604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 34 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,42 @@
# Data-Structures-and-Algorithms-in-cpp
This is very good piece of coding.
This repository is in development phase and will soon provide you with c++ code of various data structures and algorithms
This repository is in development phase and will soon provide you with C++ code of various data structures and algorithms.

## Who can contribute
Anyone can contribute to this repositry.
# User Guide

## What is this for?
This project is designed to be a reference for anyone needing to implement a particular data structure or algorithm into their C++ program.

## How to Use
* Find the folder with the name of your Data Structure or Algorithm
* Browse C++ implementations of your chosen topic
* Your topic isn't there?
* Consider contributing to help fill the gaps

# Contribution Guide

## How to contribute
<ul>
<li>Fork this repository</li>
<li>Pick up an algortihm</li>
<li>Write your code</li>
<li>Create a pull request</li>
<li>Star the repository to show your support</li>
</ul>

## Instructions
Create a folder for the topic you wish to contribute in and add the respective files in that particular folder.
If a folder for a particular Data Structure or Algorithm exists. Add your codes in that folder itself.
If a folder already exists, add your codes to it.

### Additional Notes
## Who can contribute?
Anyone can contribute to this repository.

## How to Contribute
1. Fork this repository
2. Pick up an algortihm
3. Write your C++ code
4. Follow the <span style="color:blue">File Placement</span> guide below
5. Create a pull request
6. Star the repository to show your support

## File Placement Instructions
* Look for a folder for the topic you wish to contribute in (ex. Trees, Sorting, etc.)
* If your particular Data Structure or Algorithm folder exists, add the relevant files there
* If a folder does not exist, create a new one for your topic

## Code Guidelines
* Code should be properly commented so as to ensure it's readability.
* If you've added code that should be tested, add tests as comments.
* Make sure your code is properly formatted.

<p align="center">
<img src="images/Good_Documentation.png" /><br/>
<style="font-size: .8em">Example of good documentation</>
</p>

34 changes: 34 additions & 0 deletions README.md.backup
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Data-Structures-and-Algorithms-in-cpp
This repository is in development phase and will soon provide you with C++ code of various data structures and algorithms.

## What is this for?
This project is designed to be a reference for anyone needing to implement a particular data structure or algorithm into their C++ program.

# Contribution Guide

## Who can contribute?
Anyone can contribute to this repository.

## How to Contribute
1. Fork this repository
2. Pick up an algortihm
3. Write your C++ code
4. Follow the File Placement guide below
5. Create a pull request
6. Star the repository to show your support

## File Placement Instructions
* Look for a folder for the topic you wish to contribute in (ex. Trees, Sorting, etc.)
* If your particular Data Structure or Algorithm folder exists, add the relevant files there
* If a folder does not exist, create a new one for your topic

## Code Guidelines
* Code should be properly commented so as to ensure it's readability.
* If you've added code that should be tested, add tests as comments.
* Make sure your code is properly formatted.

<p align="center">
<img src="images/Good_Documentation.png" /><br/>
<style="font-size: .8em">Example of good documentation</>
</p>

Binary file added images/Good_Documentation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.