First of all... THANK YOU FOR THINKING OF CONTRIBUTING. We appreciate all the support. Information to help with contributing is below
Tests can be ran locally using make test. This will require that
all dependencies must be installed (required plugins and treesitter parsers).
Tests can also be run in each _spec file with the
Plenary test harness
Use make fmt to run stylua
on repo
Use make lint to run luacheck
on repo
Tests, Formatting, and Linting are required to pass as part of the CI process.
You can run make pr-ready to go through all of these locally.
If you don't want to have all the dependencies installed locally you can use
make docker-build to build a docker container with all the tests, linting,
and formatting dependencies. Then use make pr-ready-docker to run tests,
linting, formatting inside the docker container.
NOTE be sure to run make docker-build if your branch is long lived as
we use the latest build of neovim for testing/support.
If you open a PR that's not ready for review, please keep it as a draft. This will run the CI, but let us know not to review your PR yet. Also please list what is being fixed in PR with tests added (if applicable).