Merge pull request #2 from TheAlgorithms/feat-contributing-guide

raksonibs · web-flow · commit 9cf3dbd8df00 · 2019-11-22T01:10:06.000-08:00
Basic Files for Setup
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,4 @@
+[report]
+sort = Cover
+omit =
+    .env/*
diff --git a/.formatter.exs b/.formatter.exs
@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,23 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+algorithims-*.tar
diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1,2 @@
+erlang 21.2.3
+elixir 1.8.0
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,27 @@
+language: elixir
+elixir:
+  - 1.9.0
+
+otp_release:
+  - 20.3
+  - 22.0
+
+matrix:
+  exclude:
+  - elixir: 1.6.6
+    otp_release: 22
+
+script:
+  - mix format --check-formatted
+  - mix deps.get
+  - mix test
+
+  # check for any trailing whitespace
+  - "! git grep ' $' -- \\*.exs"
+
+sudo: false
+
+cache:
+  directories:
+    - _build
+    - deps
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,51 @@
+# Contributing guidelines
+
+## Before contributing
+
+Welcome to [TheAlgorithms/Elixir](https://github.com/TheAlgorithms/Elixir)! 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/Elixir/issues/new) or ask the community in [Gitter](https://gitter.im/TheAlgorithms).
+
+## Contributing
+
+### Contributor
+
+We are very happy that you consider implementing algorithms and data structure for others! This repository is referenced and used by learners from all over the globe. Being one of our contributors, you agree and confirm that:
+
+- You did your work - no plagiarism allowed
+  - Any plagiarized work will not be merged.
+- Your work will be distributed under [MIT License](License) once your pull request is merged
+- You submitted work fulfils or mostly fulfils our styles and standards
+
+**New implementations** are welcome! For example, new solutions for a problem, different representations for 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 a grammar mistake in a comment to implementing complex algorithms. Please read this section if you are contributing your work.
+
+Your contribution will be tested by our [automated testing on Travis CI](https://travis-ci.org/TheAlgorithms/Elixir/pull_requests) to save time and mental energy.  After you have submitted your pull request, you should see the Travis tests start to run at the bottom of your submission page.  If those tests fail, then click on the ___details___ button try to read through the Travis output to understand the failure.  If you do not understand, please leave a comment on your submission page and a community member will try to help.
+
+#### Coding Style
+
+We want your work to be readable by others; therefore, we encourage you to note the following:
+
+- Original code submission require module definitions or comments to describe your work.
+- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
+- If you need a third party module that is not in the file __mix.exs__, please add it to that file as part of your submission.
+- Format your work, or it will fail the tests.
+
+#### Other Standards While Submitting Your Work
+
+- Strictly use snake_case (underscore_separated) in your file_name, as it will be easy to parse in future using scripts.
+- If you have modified/added code work, make sure the code compiles before submitting.
+- If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
+- Do not update the README.md or DIRECTORY.md file which will be periodically autogenerated by our Travis CI processes.
+- Add a corresponding explanation to [Algorithms-Explanation](https://github.com/TheAlgorithms/Algorithms-Explanation) (Optional but recommended).
+
+
+- Most importantly,
+  - **Be consistent in the use of these guidelines when submitting.**
+  - **Join** [Gitter](https://gitter.im/TheAlgorithms) **now!**
+  - Happy coding!
+
+Writer [@raksonibs](https://github.com/raksonibs), Nov 2019.
diff --git a/DIRECTORY.md b/DIRECTORY.md
@@ -1 +1,60 @@
 
+
+## Arithmetic Analysis
+
+## Backtracking
+
+## Blockchain
+
+## Boolean Algebra
+
+## Ciphers
+
+## Compression
+
+## Conversions
+
+## Data Structures
+  * Linked List
+    * [Singly Linked List](https://github.com/TheAlgorithms/Python/blob/master/data_structures/linked_list/singly_linked_list.py)
+
+## Digital Image Processing
+
+## Divide And Conquer
+
+## Dynamic Programming
+
+## File Transfer
+
+## Fuzzy Logic
+
+## Graphs
+
+## Hashes
+
+## Linear Algebra
+
+## Machine Learning
+
+## Maths
+
+## Matrix
+
+## Networking Flow
+
+## Neural Network
+
+## Other
+
+## Project Euler
+
+## Searches
+
+## Sorts
+
+## Strings
+
+## Traversals
+
+## Web Programming
+  
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2019 The Algorithms
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -12,6 +12,9 @@ These implementations are for learning purposes. They may be less efficient than
 
 Read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
 
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm).
+
 ## Community Channel
 
 We're on [Gitter](https://gitter.im/TheAlgorithms)! Please join us.
diff --git a/lib/algorithims.ex b/lib/algorithims.ex
@@ -0,0 +1,18 @@
+defmodule Algorithims do
+  @moduledoc """
+  Documentation for Algorithims.
+  """
+
+  @doc """
+  Hello world.
+
+  ## Examples
+
+      iex> Algorithims.hello()
+      :world
+
+  """
+  def hello do
+    :world
+  end
+end
diff --git a/lib/data_structures/singly_linked_list.ex b/lib/data_structures/singly_linked_list.ex
@@ -0,0 +1,15 @@
+defmodule Algorithims.DataStructures.SinglyLinkedList do
+  defmodule SingleLink, do: defstruct([:value, :reference])
+
+  def add_node([], value) do
+    [form_link(value, nil)]
+  end
+
+  def add_node([head | _tail] = list, value) do
+    [form_link(value, head) | list]
+  end
+
+  defp form_link(value, reference) do
+    %__MODULE__.SingleLink{value: value, reference: reference}
+  end
+end
diff --git a/mix.exs b/mix.exs
@@ -0,0 +1,28 @@
+defmodule Algorithims.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :algorithims,
+      version: "0.1.0",
+      elixir: "~> 1.9",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger]
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      # {:dep_from_hexpm, "~> 0.3.0"},
+      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
+    ]
+  end
+end
diff --git a/test/algorithims_test.exs b/test/algorithims_test.exs
@@ -0,0 +1,8 @@
+defmodule AlgorithimsTest do
+  use ExUnit.Case
+  doctest Algorithims
+
+  test "greets the world" do
+    assert Algorithims.hello() == :world
+  end
+end
diff --git a/test/data_structures/singly_linked_list_test.exs b/test/data_structures/singly_linked_list_test.exs
@@ -0,0 +1,45 @@
+defmodule Algorithims.DataStructures.SinglyLinkedListTest do
+  alias Algorithims.DataStructures.SinglyLinkedList
+
+  use ExUnit.Case
+  doctest Algorithims
+
+  describe "add_node/2" do
+    test "it works when the list is empty" do
+      assert SinglyLinkedList.add_node([], 3) == [
+               %SinglyLinkedList.SingleLink{
+                 value: 3,
+                 reference: nil
+               }
+             ]
+    end
+
+    test "it adds to the head" do
+      list =
+        SinglyLinkedList.add_node([], 3)
+        |> SinglyLinkedList.add_node(4)
+        |> SinglyLinkedList.add_node(5)
+
+      assert list == [
+               %Algorithims.DataStructures.SinglyLinkedList.SingleLink{
+                 reference: %Algorithims.DataStructures.SinglyLinkedList.SingleLink{
+                   reference: %Algorithims.DataStructures.SinglyLinkedList.SingleLink{
+                     reference: nil,
+                     value: 3
+                   },
+                   value: 4
+                 },
+                 value: 5
+               },
+               %Algorithims.DataStructures.SinglyLinkedList.SingleLink{
+                 reference: %Algorithims.DataStructures.SinglyLinkedList.SingleLink{
+                   reference: nil,
+                   value: 3
+                 },
+                 value: 4
+               },
+               %Algorithims.DataStructures.SinglyLinkedList.SingleLink{reference: nil, value: 3}
+             ]
+    end
+  end
+end
diff --git a/test/test_helper.exs b/test/test_helper.exs
@@ -0,0 +1 @@
+ExUnit.start()

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +[report]
 +sort = Cover
 +omit =
 +    .env/*