From 7be9986a4a4d7c9faddeeb9e80bafc9d3547e32e Mon Sep 17 00:00:00 2001 From: glepnir Date: Tue, 15 Oct 2024 18:05:26 +0800 Subject: docs: add requirement of a new server (#3368) * docs: add requirement of a new server Co-authored-by: Justin M. Keyes --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b79c9d2..979ff78b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,14 @@ The point of lspconfig is to provide the minimal configuration necessary for a s ## Adding a server to lspconfig +New configs must meet these criteria (to avoid spam/quasi-marketing/vanity projects): + +- GitHub Stars: The server repository should have at least 100 stars, or some other evidence (such as vscode marketplace downloads) that the LSP server is reasonably popular and is not spam/quasi-marketing/vanity projects. +- Provide some reference or evidence that the language targeted by the LSP server has an active user base. + +This helps ensure that we only include actively maintained and widely used servers to provide a better experience for +the community. + To add a new language server, start with a minimal skeleton. See `:help lspconfig-new`. When choosing a config name, convert dashes (`-`) to underscores (`_`). If the name of the server is a unique name (`pyright`, `clangd`) or a commonly used abbreviation (`zls`), prefer this as the server name. If the server instead follows the pattern x-language-server, prefer the convention `x_ls` (`jsonnet_ls`). -- cgit v1.2.3-70-g09d2