Skip to content
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

Update README.md #626

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
56 changes: 46 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,63 @@
# 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

## Who can contribute
Anyone can contribute to this repositry.
Welcome to cppDataStructures and Algorithms. We are dedicated to helping the world of C++ programming through comprehensive data structures and algorithms implementations. Our community-driven project aims to provide programmers of all levels with high-quality, well-documented, and efficient solutions for solving complex problems.

# Contribution Guide
## Who can contribute
We welcome contributions of all kinds, from bug reports and feature requests to code contributions and documentation improvements. Please feel free to contribute no matter your experience.

## How to contribute
<ul>
<li>Fork this repository</li>
<li>Pick up an algortihm</li>
<li>Write your code</li>
<li>Clone the forked repository to your machine</li>
<li>Create a branch</li>
<li>Choose a Data Structure or Algorithm (or both)</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.

### Data Structures
<ul>
<li>Create a file in the folder of your chosen Data Structure</li>
<li>If it does not exist, create a new folder</li>
<li>Please use header and source files to separate</li>
<li>Create sub-folders for any algorithms related to your data structure</li>
<li>If you are changing an existing data structure, be sure to describe what you changed and how it improves the codebase</li>
</ul>

### Algorithms
<ul>
<li>If your algorithm can be generalized(i.e. sorting), please add it to that folder</li>
<li>Else, create a new file and name it after your algorithm</li>
<li>If you are editing an existing algorithm, be sure to describe what you changed and how it improves the algorithm</li>
</ul>

### Additional Notes
* 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.

### Data Structures

| Data Structure/Algorithm | What's Done |
|----------------------|----------------|
| **Array** | Merge Sort, Bubble Sort, Quick Sort, Sliding Window|
| **Graphs** | Adjacency Matrix, Adjacency List, DFS, BFS, Kruskal's |
| **Heap** | Help Needed |
| **Linked Lists** | Doubly Linked List, Deletion, Merge, Mode |
| **Maps** | Help Needed|
| **Queue** | Implementation |
| **Stack** | Implementation |
| **Trees** | Level Order Traversal, B-Tree, Binary Search Tree|

### Algorithms

| Algorithms|
|----------------------|
| **Incremental** |
| **Fibonacci Recursion** |
| **Huffman** |
| **Pot Of Gold** |
| **Pascal's Triangle** |
| **Tower of Hanoi** |