Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.86 KB

Contributing

Local Environment

For lua-language-server to pick up the testing libraries in use, you'll need to download the appropriate addons for lua-language-server. This can be done automatically for you by running make lsp-addons. They can be updated by using make update-lsp-addons.

You will also need stylua and luacheck installed to run formatting and linting. If you are a Nix + direnv user, you can simply run direnv allow and have the flake.nix set up your environment for you (or run nix develop if you prefer not to use direnv).

Code Style

When contributing to legendary.nvim, please make sure your code passes all checks. If you have Stylua and Luacheck installed, you can run the checks locally by running make check. This will run the linter, the style checker, and all unit tests. Make sure to follow the code style found in the existing code.

PRs

PR titles are now used to generate changelogs for GitHub Releases. Please try your best to title PRs according to conventional commits.

Issues vs. Discussions