diff --git a/README.md b/README.md index aea147c8..a5dca766 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Data Structures and Algorithm + Data structure and Algorithm (DSA) ## Contribution Guidelines @@ -7,13 +8,15 @@ Data structure and Algorithm (DSA) The problem being contributed must either be a simple **file** (**Eg.** [`kruskal-algorithm.cpp`](https://github.com/MakeContributions/DSA/blob/main/graphs/c-or-cpp/kruskal-algorithm.cpp), [`linear-search.java`](https://github.com/MakeContributions/DSA/blob/main/searching/java/linear-search.java)) or a more complex **directory** ([`palindrome/`](https://github.com/MakeContributions/DSA/tree/main/strings/rust/palindrome)). This is a unit `problem`. -The directory tree has the following convention of `category/language/problem`, where `category` is the topic or category of the problem being contributed (**Eg.** `strings`, `sorting`, `linked-lists` etc.), `language` represents the language code of the problem (**Eg.** `c-or-cpp` for C/C++, `python` for Python, `java` for Java etc.), and `problem` is a conforming name to the problem (**Eg.** `linear-search.cpp`, `palindrome`, `queue-linked-list.cpp` etc.) +The directory tree has the following convention of `category/language/problem`, where `category` is the topic or category of the problem being contributed (**Eg.** `strings`, `sorting`, `linked-lists` etc.), `language` represents the language code of the problem (**Eg.** `c-or-cpp` for C/C++, `python` for Python, `java` for Java etc.), and `problem` is a conforming name to the problem (**Eg.** `linear-search.cpp`, `palindrome`, `queue-linked-list.cpp` etc.) A unit `problem` must conform to the following specifications: + - The name should be in lowercase. (**Eg.** `palindrome/`, `binary-search.cpp` etc.). - Each word must be separated by a **dash** or a **hyphen** (`-`). -**If you have a problem that belongs to a new *topic* or *category* than one which are present:** +**If you have a problem that belongs to a new _topic_ or _category_ than one which are present:** + 1. Create a new folder and an index for it inside (a readme, `README.md` file). 2. To each new index file, write the readme with your `problem` in it ([Markdown Documentation](https://guides.github.com/features/mastering-markdown/)). 3. The folder name can also only contain **lowercase characters** and **dashes** or **hyphens** (`-`) (Eg. `strings` `sorting` etc.) @@ -29,6 +32,7 @@ The project and folder-based contributions have a bit more stricter contribution The folder should conform to the `problem` specification, along with the following specifications **Folder Structure** + ```bash problem-name\ | - .gitignore @@ -40,7 +44,7 @@ problem-name\ #### `README.md` Specification / Template -```markdown +````markdown #