From 6d27728246dcb9ef48f769941acc9a0d8cc49be7 Mon Sep 17 00:00:00 2001 From: Ming Tsai <37890026+ming-tsai@users.noreply.github.com> Date: Wed, 7 Apr 2021 14:32:02 -0400 Subject: [PATCH] docs: update Contribution Guidelines --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1cc0c181..7fe521cf 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Data structure and Algorithm (DSA) ## Contribution Guidelines -### **1. Contribution Specifications** +### 1. Contribution Specifications 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`. @@ -18,11 +18,11 @@ A unit `problem` must conform to the following specifications: 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.) -### Simple (File) Contributions +#### Simple (File) Contributions The file should conform to the `problem` specification, and the extension (**Eg.** `linear-search.java`, `kruskal-algorithm.cpp`, `count-inversions.js` etc.) -### Project/Folder-based Contributions +#### Project/Folder-based Contributions The project and folder-based contributions have a bit more stricter contribution contribution specifications. @@ -38,7 +38,7 @@ problem-name\ | - main.ext ``` -#### - `README.md` Specification / Template +#### `README.md` Specification / Template ```markdown #