CONTRIBUTING.md

Contributing to fast-elixir

Thank you for contributing! Let's get you started!

Adding a benchmark

1. Fork and clone the repository

2. Install dependencies: mix deps.get

3. Write a benchmark using the following template:

   defmodule IdiomName.Fast do
     def function_name do
     end
   end
   
   defmodule IdiomName.Slow do
     def function_name do
     end
   end
   
   defmodule IdiomName.Benchmark do
     def benchmark do
       Benchee.run(%{
         "Idiom Name Fast" => fn -> bench(IdiomName.Fast) end,
         "Idiom Name Slow" => fn -> bench(IdiomName.Slow) end,
       }, time: 10, print: [fast_warning: false])
     end
   
     defp bench(module) do
       module.function_name
     end
   end
   
   IdiomName.Benchmark.benchmark()

4. Run your benchmark: mix run code/<category>/<benchmark>.exs

5. Add the output along with a description to the README.

6. Open a Pull Request!