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] 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)