search

tekumara / typos-lsp

Source code spell checker for Visual Studio Code, Neovim and other LSP clients
https://marketplace.visualstudio.com/items?itemName=tekumara.typos-vscode
MIT License
162 stars 4 forks source link

docs: add a contributing guide for typos-lsp #70

Closed mikavilpas closed 1 month ago

mikavilpas commented 1 month ago

This includes a basic guide for setting up the development environment in terms of the rust side (server) as well as the editor side (client).

Currently instructions are provided for Neovim.

I verified the setup works for me (as in, I see errors in neovim 🙂) and also consulted what seemed to be your dotfiles for reference (link)

mikavilpas commented 1 month ago

I started to look into https://github.com/tekumara/typos-lsp/issues/12 and wanted to set up my environment as the first step. Figured it might be helpful for other contributors as well.

mikavilpas commented 1 month ago

As a reference, my config is here https://github.com/mikavilpas/dotfiles/blob/main/.config/nvim/lua/plugins/typos.lua?plain=1

I'm pretty sure it's equivalent to the guide, though.

tekumara commented 1 month ago

Thanks for this! I've renamed this to the standard CONTRIBUTING.md and linked to it from README.md