Community

Luerl embraces both the Lua and Erlang communities and ecosystems, which are simple, diverse, and complementary. Whether you are embedding Luerl for the first time or poking at the VM internals, you are welcome here.

Get Involved

The best way to get involved is to use Luerl, ask questions, and help other users. Pick a lane:

  • Report a bug or request a feature — open a GitHub issue. Search first to avoid duplicates, and include the Luerl version, your Erlang/OTP version, and a minimal reproduction.
  • Fix a bug or add a feature — fork the repo, branch from develop, and open a pull request.
  • Improve the documentation — the project wiki and the reference on hexdocs always need help.
  • Help others — answer questions on Discord or the Erlang Forums.
  • Build something — embed Luerl in a project and share what you make. The community loves real-world examples.

Contributing Code

Luerl is developed on GitHub under the Apache-2.0 license. Contributions arrive as pull requests, and the maintainers are small — a clear, well-tested PR goes a long way.

  1. Fork github.com/rvirding/luerl.
  2. Create a branch from develop — it is the default branch and where all work lands. Please do not PR against master.
  3. Make your change, adding tests under test/ where possible.
  4. Run the same checks CI runs: sh rebar3 do eunit, ct --cover, cover rebar3 dialyzer
  5. Open a pull request against develop and link any related issue.

The CI matrix runs Erlang/OTP 24 through 27 on GitHub Actions, so your PR is automatically validated across the supported OTP range. Keep changes focused, add a CHANGELOG entry for user-visible changes, and follow the existing code style.

Join the Community

The project spans two ecosystems, so there are several places where conversation happens. All links below are actively used.

Luerl on Discord — real-time chat; the canonical invite from the project README.

Luerl on Slack — join by requesting an invite via ERLEF.

Luerl Forum — Erlang Forums — longer-form Q&A and announcements, tagged with luerl-chat, luerl-questions, luerl-libraries, and luerl-news.

Issues — bug reports and feature requests.

Pull requests — code contributions.

Wiki — documentation and the getting-started guide.

Code — the repository itself.

hex.pm — releases and the list of projects that depend on Luerl.

Learning

The official definition of the Lua language is given in the reference manual. The hexdocs site hosts the generated API reference for the current release.

Videos