Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.46 KB

Conventions and Tips to Contribute to developing

Dependencies

As of January 2023 this project relies on Lua 5.3 . (This is because as of mid 2022 MikTeX's luatex uses Lua 5.3 .)

Ensure that you can run a Lua interpreter from anywhere: Open any terminal window and try to execute lua -v.

IDE

The maintainer recommends to use Visual Studio Code as the IDE. You will need to install the following extensions:

  • Lua by sumneko
  • Lua Debug by actboy168
  • Lua Test Adapter by Linus Sunde These extensions are configured by the .json files in the .vscode directory.

Code Formatting

All code is formatted manually. Please turn off any code formatting/pretty-printing/refactoring features.

Unit Tests

To execute the unit tests you must have

  • a Bash shell available[^1]
  • installed Lua >= 5.3
  • installed LuaRocks
  • installed luafilesystem via luarocks
  • installed luaunit via luarocks

Then run from the repository root:

$ ./test/run_all_unit_tests.bash

[^1] scripts for powershell are maybe implemented in the future, but that is not a priority. Feel free to write one.