Changed folder structure (Issue Asiatik#52) (Asiatik#53)

* Changed folder structure * Fixed link in README
sambey04 · Sep 30, 2018 · 7a3efb1 · 7a3efb1
1 parent 2655cfd
commit 7a3efb1
Show file tree

Hide file tree

Showing 38 changed files with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -22,6 +22,13 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 4. Ensure the test suite passes.
 5. Issue that pull request from your feature branch!
 
+## Adding a new algorithm or data structure.
+
+Make sure you adhere to the `algorithm/language/file` folder structure while adding code.
+
+Additionally we recommend using standard convention for your language such as indentation and variable naming while writing the algorithm.
+Useful comments will be a help. Finally, if you can write tests for you code, we urge you to do so.
+
 ## Any contributions you make will be under the MIT License
 In short, when you submit code changes, your submissions are understood to be under the same MIT License
 that covers the project. Feel free to contact the maintainers if that's a concern.

diff --git a/Data_Structures/.gitkeep → Data Structures/.gitkeep b/Data_Structures/.gitkeep → Data Structures/.gitkeep
diff --git a/Data_Structures/Java/SinglyLinkedList.java → ...s/Linked Lists/Java/SinglyLinkedList.java b/Data_Structures/Java/SinglyLinkedList.java → ...s/Linked Lists/Java/SinglyLinkedList.java
diff --git a/Data_Structures/Stack.java → Data Structures/Stack/Java/Stack.java b/Data_Structures/Stack.java → Data Structures/Stack/Java/Stack.java
diff --git a/Dynamic_Programming/.gitkeep → Dynamic Programming/.gitkeep b/Dynamic_Programming/.gitkeep → Dynamic Programming/.gitkeep
diff --git a/Graph_Algorithms/.gitkeep → Graphs/.gitkeep b/Graph_Algorithms/.gitkeep → Graphs/.gitkeep
diff --git a/Greedy_Algorithms/.gitkeep → Greedy/.gitkeep b/Greedy_Algorithms/.gitkeep → Greedy/.gitkeep
diff --git a/JS_Design_Patterns/singleton.js → JS Design Patterns/singleton.js b/JS_Design_Patterns/singleton.js → JS Design Patterns/singleton.js
diff --git a/Java_Design_Patterns/.gitkeep → Java Design Patterns/.gitkeep b/Java_Design_Patterns/.gitkeep → Java Design Patterns/.gitkeep
diff --git a/Java_Design_Patterns/SingletonClass.java → Java Design Patterns/Singleton Class.java b/Java_Design_Patterns/SingletonClass.java → Java Design Patterns/Singleton Class.java
diff --git a/Machine_Learning/.gitkeep → Machine Learning/.gitkeep b/Machine_Learning/.gitkeep → Machine Learning/.gitkeep
diff --git a/README.md b/README.md
@@ -9,6 +9,10 @@ Feel free to contribute. Create an issue, let others know which algorithm/data s
 
 > The goal is to create a codebase for developers to access. Later we aim to develop extensions using this codebase to support multiple IDEs.
 
+## Contributing
+
+We are open to contributions. Make sure you read [how to contribute](CONTRIBUTING.md) before contributing. 
+
 ## License
 
 [MIT License]

diff --git a/Searching/Binary_Search/C++/BinarySearch.cpp → Searching/Binary Search/C++/BinarySearch.cpp b/Searching/Binary_Search/C++/BinarySearch.cpp → Searching/Binary Search/C++/BinarySearch.cpp
diff --git a/Searching/Binary_Search/C/BinarySearch.c → Searching/Binary Search/C/BinarySearch.c b/Searching/Binary_Search/C/BinarySearch.c → Searching/Binary Search/C/BinarySearch.c
diff --git a/...hing/Binary_Search/Java/BinarySearch.java → ...hing/Binary Search/Java/BinarySearch.java b/...hing/Binary_Search/Java/BinarySearch.java → ...hing/Binary Search/Java/BinarySearch.java
diff --git a/...hing/Binary_Search/Python/BinarySearch.py → ...hing/Binary Search/Python/BinarySearch.py b/...hing/Binary_Search/Python/BinarySearch.py → ...hing/Binary Search/Python/BinarySearch.py
diff --git a/Searching/Binary_Search/README.md → Searching/Binary Search/README.md b/Searching/Binary_Search/README.md → Searching/Binary Search/README.md
diff --git a/Searching/Linear_Search/C++/LinearSearch.cpp → Searching/Linear Search/C++/LinearSearch.cpp b/Searching/Linear_Search/C++/LinearSearch.cpp → Searching/Linear Search/C++/LinearSearch.cpp
diff --git a/Searching/Linear_Search/C/LinearSearch.c → Searching/Linear Search/C/LinearSearch.c b/Searching/Linear_Search/C/LinearSearch.c → Searching/Linear Search/C/LinearSearch.c
diff --git a/...hing/Linear_Search/Java/LinearSearch.java → ...hing/Linear Search/Java/LinearSearch.java b/...hing/Linear_Search/Java/LinearSearch.java → ...hing/Linear Search/Java/LinearSearch.java
diff --git a/...hing/Linear_Search/Python/LinearSearch.py → ...hing/Linear Search/Python/LinearSearch.py b/...hing/Linear_Search/Python/LinearSearch.py → ...hing/Linear Search/Python/LinearSearch.py
diff --git a/Searching/Linear_Search/README.md → Searching/Linear Search/README.md b/Searching/Linear_Search/README.md → Searching/Linear Search/README.md
diff --git a/Sorting/C#/BubbleSort.cs → Sorting/Bubble Sort/C#/BubbleSort.cs b/Sorting/C#/BubbleSort.cs → Sorting/Bubble Sort/C#/BubbleSort.cs
diff --git a/Sorting/Java/BubbleSort.java → Sorting/Bubble Sort/Java/BubbleSort.java b/Sorting/Java/BubbleSort.java → Sorting/Bubble Sort/Java/BubbleSort.java
diff --git a/Sorting/C++/Heap_Sort.cpp → Sorting/Heap Sort/C++/HeapSort.cpp b/Sorting/C++/Heap_Sort.cpp → Sorting/Heap Sort/C++/HeapSort.cpp
diff --git a/Sorting/Java/InsertionSort.java → ...ng/Insertion Sort/Java/InsertionSort.java b/Sorting/Java/InsertionSort.java → ...ng/Insertion Sort/Java/InsertionSort.java
diff --git a/...g/C++/MergeSort_Arrays/MergeSortArray.cpp → .../Merge Sort/C++/Arrays/MergeSortArray.cpp b/...g/C++/MergeSort_Arrays/MergeSortArray.cpp → .../Merge Sort/C++/Arrays/MergeSortArray.cpp
diff --git a/...ing/C++/MergeSort_Arrays/MergeSortArray.h → ...ng/Merge Sort/C++/Arrays/MergeSortArray.h b/...ing/C++/MergeSort_Arrays/MergeSortArray.h → ...ng/Merge Sort/C++/Arrays/MergeSortArray.h
diff --git a/.../MergeSort_Arrays/MergeSort_ArrayTest.cpp → ...ge Sort/C++/Arrays/MergeSortArrayTest.cpp b/.../MergeSort_Arrays/MergeSort_ArrayTest.cpp → ...ge Sort/C++/Arrays/MergeSortArrayTest.cpp
diff --git a/...eSort_LinkedLists/MergeSortLinkedList.cpp → .../C++/Linked Lists/MergeSortLinkedList.cpp b/...eSort_LinkedLists/MergeSortLinkedList.cpp → .../C++/Linked Lists/MergeSortLinkedList.cpp
diff --git a/...rgeSort_LinkedLists/MergeSortLinkedList.h → ...rt/C++/Linked Lists/MergeSortLinkedList.h b/...rgeSort_LinkedLists/MergeSortLinkedList.h → ...rt/C++/Linked Lists/MergeSortLinkedList.h
diff --git a/..._LinkedLists/MergeSort_LinkedlistTest.cpp → .../Linked Lists/MergeSortLinkedListTest.cpp b/..._LinkedLists/MergeSort_LinkedlistTest.cpp → .../Linked Lists/MergeSortLinkedListTest.cpp
diff --git a/Sorting/C++/Merge_Sort_Array → Sorting/Merge Sort/C++/MergeSortArray.cpp b/Sorting/C++/Merge_Sort_Array → Sorting/Merge Sort/C++/MergeSortArray.cpp
diff --git a/Sorting/Java/MergeSort.java → Sorting/Merge Sort/Java/MergeSort.java b/Sorting/Java/MergeSort.java → Sorting/Merge Sort/Java/MergeSort.java
diff --git a/Sorting/C++/QuickSort.cpp → Sorting/Quick Sort/C++/QuickSort.cpp b/Sorting/C++/QuickSort.cpp → Sorting/Quick Sort/C++/QuickSort.cpp
diff --git a/Sorting/Java/QuickSort.java → Sorting/Quick Sort/Java/QuickSort.java b/Sorting/Java/QuickSort.java → Sorting/Quick Sort/Java/QuickSort.java
diff --git a/Sorting/Java/SelectionSort.java → ...ng/Selection Sort/Java/SelectionSort.java b/Sorting/Java/SelectionSort.java → ...ng/Selection Sort/Java/SelectionSort.java
diff --git a/String_Manipulation/.gitkeep → String Manipulation/.gitkeep b/String_Manipulation/.gitkeep → String Manipulation/.gitkeep