Contributing guide

Contributions are more than welcome!

Please don't forget to add your changes to the "Unreleased" section of the changelog (if applicable).

Commit messages

I use nix (with flakes enabled) for development and testing.

Formatting is done with stylua.

To enter a development shell:

nix develop

To apply formatting, while in a devShell, run

pre-commit run --all

If you use direnv, just run direnv allow and you will be dropped in this devShell.

I use busted for testing, but with Neovim as the Lua interpreter.

The easiest way to run tests is with Nix (see below).

If you do not use Nix, you can also run the test suite using luarocks test. For more information on how to set up Neovim as a Lua interpreter, see

Or

Note

The Nix devShell sets up luarocks test to use Neovim as the interpreter.

If you just want to run all checks that are available, run:

nix flake check --print-build-logs

To run tests locally

nix build .#checks.<your-system>.ci --print-build-logs

For formatting:

nix build .#checks.<your-system>.formatting --print-build-logs