Thank you for your interest in contributing to the Lua Language Server! Your contributions help improve the experience for all users.
I want to...
- Contribute features/fixes
- Create LuaCATS annotations
- Help translate to another language
- Improve this wiki
Is there something else I can do?
- Star the repository if you find the project helpful
- Spread the word!
- You can sponsor the project
If you're familiar with Lua, you can grab the source code and dive in. There are additional wiki articles that go more in-depth on building from source and developing. An overview of the project's file structure can be found on the developing page.
We don't have a strict git workflow that needs to be followed. When you have some changes ready to merge, open a pull request . If you need some help, feel free to open a draft pull request – although please be patient and keep in mind that the team is very small.
When making changes to the language server, please make sure to add an entry to the project's changelog file, so it is documented and advertised to users.
The Lua Language Server implements a system for defining and documenting code called LuaCATS (Lua Comment And Type System). You can contribute to our ecosystem by writing LuaCATS annotations for widely used Lua libraries. These can help give users out-of-the-box autocompletion and type checking for the library. This is done by creating definition files that can then be included in an addon and distributed using the addon manager.
You can browse annotations maintained by the community in the LuaCATS organization .