How to contribute to Elixir

The post outlines a practical workflow for contributing to Elixir. It starts with cloning the repository, checking that the code compiles, and running the full test suite before making changes. After editing, it suggests recompiling, narrowing tests to a package or a single test file when needed, and using a custom build in a real application to confirm the changes behave as expected.

Reading notes

#

• Clone Elixir, run make compile, and then make test to confirm the project builds and the tests pass.
• If either step fails, the author recommends asking for help in the #elixir-lang IRC channel on Freenode.
• After making changes, recompile and test again from the project root.
• Elixir is split into packages under lib/, including eex, elixir, ex_unit, iex, logger, and mix.
• For package-level work, the Makefile includes commands such as make test_ex_unit.
• To run one test file, compile first and then run bin/elixir -r with the test helper and the chosen test file.
• For real-world testing, prepend the custom build’s bin/ directory to $PATH so it is used first.
• Check the active binaries with which elixir and which mix.
• Recompile dependencies for the custom build with mix do deps.clean, deps.get, deps.install.
• If compilation produces a bad build, run make clean and try again.
• The post also notes that changes may need documentation, and points to Elixir’s writing documentation guide.