From 95b96775922bec3f36514cd0a5b03570903f76bd Mon Sep 17 00:00:00 2001 From: Ming Tsai <37890026+ming-tsai@users.noreply.github.com> Date: Fri, 15 Jan 2021 09:52:11 -0400 Subject: [PATCH 1/4] docs: add contribution-guidelines --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 30040704..12b88abc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,30 @@ # Data Structures and Algorithm -DSA contributions +Data structure and Algorithm (DSA) + +## Contribution Guidelines +### 1. Folders or files naming +The folder or file should have the below conditions: +- The name should be in lower case. +- The word should be separate with a **dash(-)**. +- It can only contain **dash(-)** it cannot have other specific characters. +- A new file should add to the **index(README.md)**. +For example: +``` +DSA + | searching + | readme.md -> should create an readme for the index + | c-or-cpp + | linear-search.cpp + | binary-search.cpp + | python + | linear-search.py + | binary-search.py + | csharp + | linear-search.cs + | binary-search.cs +``` +### 2. Naming Convention +The programming should keep the naming convention rule of each programming language ## License [MIT](./LICENSE) From 86b7760a9636165147dd3f0e8a27e1999f54a67d Mon Sep 17 00:00:00 2001 From: Ming Tsai <37890026+ming-tsai@users.noreply.github.com> Date: Fri, 15 Jan 2021 09:54:49 -0400 Subject: [PATCH 2/4] docs: add missing new separate line --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12b88abc..9041ce18 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,11 @@ Data structure and Algorithm (DSA) ## Contribution Guidelines ### 1. Folders or files naming The folder or file should have the below conditions: +- A new file should add to the **index(README.md)**. - The name should be in lower case. - The word should be separate with a **dash(-)**. - It can only contain **dash(-)** it cannot have other specific characters. -- A new file should add to the **index(README.md)**. + For example: ``` DSA From b98fc2f0b1fc2e8f2939449c11a302c4fa5d667f Mon Sep 17 00:00:00 2001 From: Ming Tsai <37890026+ming-tsai@users.noreply.github.com> Date: Fri, 15 Jan 2021 11:02:33 -0400 Subject: [PATCH 3/4] docs: add when have new topic --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9041ce18..64d9d6a8 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ Data structure and Algorithm (DSA) ## Contribution Guidelines ### 1. Folders or files naming The folder or file should have the below conditions: -- A new file should add to the **index(README.md)**. - The name should be in lower case. - The word should be separate with a **dash(-)**. +- When have new topic should create a new folder and index for that topic. +- A new file should add to the **index(README.md)**. - It can only contain **dash(-)** it cannot have other specific characters. For example: From de868af6f97f1c4cc214cd18882271f98a03cd7c Mon Sep 17 00:00:00 2001 From: Ming Tsai <37890026+ming-tsai@users.noreply.github.com> Date: Sun, 17 Jan 2021 13:01:48 -0400 Subject: [PATCH 4/4] docs: add to index using relative link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 64d9d6a8..3c74230d 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ Data structure and Algorithm (DSA) The folder or file should have the below conditions: - The name should be in lower case. - The word should be separate with a **dash(-)**. -- When have new topic should create a new folder and index for that topic. -- A new file should add to the **index(README.md)**. +- When have new topic should create a new folder and index for it. +- A new file should add to the **index(README.md)** using [relative links](https://compugoddess.com/relative-vs-absolute-links/) - It can only contain **dash(-)** it cannot have other specific characters. For example: