BurhanH
diff --git a/‎.github/pull_request_template.md
Lines changed: 19 additions & 0 deletions b/‎.github/pull_request_template.md
Lines changed: 19 additions & 0 deletions
diff --git a/‎.github/workflows/UpdateDirectory.js
Lines changed: 108 additions & 0 deletions b/‎.github/workflows/UpdateDirectory.js
Lines changed: 108 additions & 0 deletions
diff --git a/‎.github/workflows/nodejs.yml
Lines changed: 25 additions & 0 deletions b/‎.github/workflows/nodejs.yml
Lines changed: 25 additions & 0 deletions
diff --git a/‎.github/workflows/update_directory_md.yml
Lines changed: 18 additions & 0 deletions b/‎.github/workflows/update_directory_md.yml
Lines changed: 18 additions & 0 deletions
diff --git a/‎Algorithms/EucledianGCD.js
Lines changed: 0 additions & 37 deletions b/‎Algorithms/EucledianGCD.js
Lines changed: 0 additions & 37 deletions
diff --git a/‎Algorithms/dynamic_programming/fibonacci.js
Lines changed: 0 additions & 25 deletions b/‎Algorithms/dynamic_programming/fibonacci.js
Lines changed: 0 additions & 25 deletions
diff --git a/‎Algorithms/sieveOfEratosthenes.js
Lines changed: 0 additions & 31 deletions b/‎Algorithms/sieveOfEratosthenes.js
Lines changed: 0 additions & 31 deletions
diff --git a/‎CONTRIBUTING.md
Lines changed: 90 additions & 0 deletions b/‎CONTRIBUTING.md
Lines changed: 90 additions & 0 deletions
@@ -0,0 +1,19 @@
+# Welcome to JavaScript community
+
+### **Describe your change:**
+
+* [ ] Add an algorithm?
+* [ ] Fix a bug or typo in an existing algorithm?
+* [ ] Documentation change?
+
+
+### **Checklist:**
+* [ ] I have read [CONTRIBUTING.md](https://github.com/TheAlgorithms/Javascript/blob/master/CONTRIBUTING.md).
+* [ ] This pull request is all my own work -- I have not plagiarized.
+* [ ] I know that pull requests will not be merged if they fail the automated tests.
+* [ ] This PR only changes one algorithm file.  To ease review, please open separate PRs for separate algorithms.
+* [ ] All new JavaScript files are placed inside an existing directory.
+* [ ] All filenames should use the UpperCamelCase (PascalCase) style.  There should be no spaces in filenames.
+     **Example:**`UserProfile.js` is allowed but `userprofile.js`,`Userprofile.js`,`user-Profile.js`,`userProfile.js` are not
+* [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
+* [ ] If this pull request resolves one or more open issues then the commit message contains `Fixes: #{$ISSUE_NO}`.
@@ -0,0 +1,108 @@
+// requiring path and fs modules
+const path = require('path');
+const fs = require('fs');
+
+let URL_BASE = "https://github.com/TheAlgorithms/Javascript/blob/master";
+let g_output = [];
+
+let filepaths = [];
+function good_filepaths(top_dir = ".") {
+  fs.readdir(top_dir, function(err, list) {
+    if (err) {
+      console.log(err);
+      return;
+    }
+    list.forEach(function(file) {
+      let path = top_dir + "/" + file;
+      if (!file.startsWith(".")) {
+        fs.stat(path, function(err, stat) {
+          if (stat && stat.isDirectory()) {
+            good_filepaths(path);
+          } else {
+            if (file.toLowerCase().endsWith(".js")) {
+              filepaths.push(path.slice(2));
+            }
+          }
+        });
+      }
+    });
+  })
+}
+
+function md_prefix(i) {
+  if (i) {
+    let res = '  '.repeat(i);
+    return res + "*";
+  } else {
+    return "\n##"
+  }
+}
+
+function print_path(old_path, new_path) {
+  let old_parts = old_path.split(path.sep);
+  let new_parts = new_path.split(path.sep);
+  for (let i = 0; i < new_parts.length; ++i) {
+    let new_part = new_parts[i];
+    if (i + 1 > old_parts.len || old_parts[i] != new_part) {
+      if (new_part) {
+        g_output.push(`${md_prefix(i)} ${new_part.replace('_', ' ')}`);
+      }
+    }
+  }
+  return new_path;
+}
+
+function build_directory_md(top_dir = ".") {
+  old_path = "";
+  filepaths.sort(function(a, b) {
+    if (a.toLowerCase() < b.toLowerCase()) return -1;
+    if (a.toLowerCase() > b.toLowerCase()) return 1;
+    return 0;
+  });
+  for (let filepath of filepaths) {
+    file = filepath.split(path.sep);
+    if (file.length == 1) {
+      filepath = "";
+      filename = file[0];
+    } else {
+      let total = file.length;
+      filename = file[total - 1];
+      filepath = file.splice(0, total - 1).join(path.sep);
+    }
+    if (filepath != old_path) {
+      old_path = print_path(old_path, filepath);
+    }
+    let indent = 0;
+    for (let i = 0; i < filepath.length; ++i) {
+      if (filepath[i] == path.sep) {
+        ++indent;
+      }
+    }
+    if (filepath) {
+      ++indent;
+    }
+    let urls = [URL_BASE, filepath, filename];
+    let url = urls.join("/").replace(" ", "%20");
+    // remove extension from filename
+    filename = filename.split(".")[0];
+    g_output.push(`${md_prefix(indent)} [${filename}](${url})`);
+  }
+  g_output = g_output.join('\n');
+  return g_output;
+}
+
+good_filepaths();
+setTimeout(() => {
+  // once the filepaths have been computed
+  build_directory_md();
+  // console.log(filepaths);
+}, 1000);
+setTimeout(() => {
+  // once the g_output has been constructed, write to the file
+  fs.writeFile('DIRECTORY.md', g_output + '\n', (err) => {
+    if (err) {
+      console.log(err);
+    }
+  })
+  // console.log(g_output);
+}, 1000);
@@ -0,0 +1,25 @@
+name: Node CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: npm install, build, and test
+      run: |
+        npm install doctest standard --save-dev
+        npx doctest Sorts/BogoSort.js Sorts/BucketSort.js
+        npx standard
+        cd Linear-Algebra
+        npm ci
+        npm run build --if-present
+        npm test
+      env:
+        CI: true
@@ -0,0 +1,18 @@
+# This GitHub Action updates the DIRECTORY.md file (if needed) when doing a git push
+name: update_directory_md
+on: [push]
+jobs:
+  update_directory_md:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@v1
+      - run: |
+          node .github/workflows/UpdateDirectory.js
+          cat DIRECTORY.md
+          git config --global user.name github-actions
+          git config --global user.email '${GITHUB_ACTOR}@users.noreply.github.com'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
+          git add DIRECTORY.md
+          git commit -am "updating DIRECTORY.md" ||  true
+          git push --force origin HEAD:$GITHUB_REF || true
@@ -0,0 +1,90 @@
+# Contributing guidelines
+
+## Before contributing
+
+Welcome to [TheAlgorithms/Javascript](https://github.com/TheAlgorithms/Javascript)! Before sending your pull requests, make sure that you **read the whole guidelines**. If you have any doubt on the contributing guide, please feel free to [state it clearly in an issue](https://github.com/TheAlgorithms/Javascript/issues/new)
+
+## Contributing
+
+### Contributor
+
+We are very happy that you consider implementing algorithms and data structures for others! This repository is referenced and used by learners from around the globe. Being one of our contributors, you agree and confirm that:
+
+- You did your work - plagiarism is not allowed.
+  - Any plagiarized work will not be merged.
+- Your work will be distributed under [GNU License](LICENSE) once your pull request is merged
+- Your submitted work must fulfill our styles and standards
+
+**New implementation** is welcome! For example, new solutions to a problem, different representations of a graph data structure or algorithm designs with different complexity.
+
+**Improving comments** and **writing proper tests** are also highly welcome.
+
+### Contribution
+
+We appreciate any contribution, from fixing grammar mistakes to implementing complex algorithms. Please read this section if you are contributing to your work.
+
+
+If you submit a pull request that resolves an open issue, please help us to keep our issue list small by adding `fixes: #{$ISSUE_NO}` to your commit message. GitHub will use this tag to auto-close the issue if your PR is merged.
+
+#### What is an Algorithm?
+
+An Algorithm is one or more functions (or classes) that:
+* take one or more inputs,
+* perform some internal calculations or data manipulations,
+* return one or more outputs,
+* have minimal side effects.
+
+Algorithms should be packaged in a way that would make it easy for readers to put them into larger programs.
+
+Algorithms should:
+* have intuitive class and function names that make their purpose clear to readers
+* use JavaScript naming conventions and intuitive variable names to ease comprehension
+* be flexible to take different input values
+* raise JavaScript exceptions (RangeError, etc.) on erroneous input values
+
+Algorithms in this repo should not be how-to examples for existing JavaScript packages.  Instead, they should perform internal calculations or manipulations to convert input values into different output values.  Those calculations or manipulations can use data types, classes, or functions of existing JavaScript packages but each algorithm in this repo should add unique value.
+
+#### File Naming Convention
+  - filenames should use the UpperCamelCase (PascalCase) style.
+  - There should be no spaces in filenames.  
+ **Example:**`UserProfile.js` is allowed but `userprofile.js`,`Userprofile.js`,`user-Profile.js`,`userProfile.js` are not
+
+#### Coding Style
+
+To maximize the readability and correctness of our code, we require that new submissions follow [JavaScript Standard Style](https://standardjs.com/)
+  - Command to  install JavaScript Standard Style
+    ```
+    $ npm install standard --save-dev
+    ```
+  - Usage
+    ```
+    $ standard MyFile.js  // if that fails, try: npx standard MyFile.js
+    ```
+
+- Use camelCase for with leading character lowercase for identifier names (variables and functions)
+- Names start with a letter
+- follow code indentation
+  - Always use 2 spaces for indentation of code blocks
+    ```
+    function sumOfArray (arrayOfNumbers) {
+        let sum = 0
+        for (let i = 0; i < arrayOfNumbers.length; i++) {
+          sum += arrayOfNumbers[i]
+        }
+        return (sum)
+      }
+
+    ```
+- Avoid using global variables and avoid '=='
+- Please use 'let' over 'var'
+- Please use 'console.log()'  
+- We strongly recommend the use of ECMAScript 6
+- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
+
+
+
+- Most importantly,
+  - **Be consistent in the use of these guidelines when submitting.**
+  - Happy coding!
+
+Writer [@itsvinayak](https://github.com/itsvinayak), May 2020.