docs: add a contributing guide for typos-lsp #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 started to look into #12 and wanted to set up my environment as the first step. Figured it might be helpful for other contributors as well. |
|
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. |
|
Thanks for this! I've renamed this to the standard CONTRIBUTING.md and linked to it from README.md |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)