diff --git a/README.md b/README.md index cd08ee6..7a66fd6 100644 --- a/README.md +++ b/README.md @@ -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 - - -## 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 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. + +

+
+ Example of good documentation +

+ diff --git a/README.md.backup b/README.md.backup new file mode 100644 index 0000000..42e63d4 --- /dev/null +++ b/README.md.backup @@ -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. + +

+
+ Example of good documentation +

+ \ No newline at end of file diff --git a/images/Good_Documentation.png b/images/Good_Documentation.png new file mode 100644 index 0000000..b7da8ed Binary files /dev/null and b/images/Good_Documentation.png differ