Do you want to help but unsure what to do?
- Feel free to come with you own ideas on how to improve the plugin. If you choose to do this then make sure to get your changes to tested and lint checks passing.
- You can take a look at the open issues and see if there is something which you can help with.
- Improve the current state of the plugin by proving more tests, improve documentation and refactor code for better readability.
The following tools are used for the project:
- luacheck for linting
- stylua for linting
- cargo for linting and building rust lib
- plenary.nvim for testing
- luacov, luacov-console and optionally luacov-lcov if you want lcov instead of luacov reports. These are needed to run tests with code coverage
Before you can run tests make sure you have built the rust source with make build
after that is done then you are all set.
To create a good PR follow this list:
- Linters passing with
make -k lint - Have tests passing with
make test - Add tests if new functionality is added