aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMichael Lingelbach <m.j.lbach@gmail.com>2021-12-26 16:22:34 -0500
committerGitHub <noreply@github.com>2021-12-26 16:22:34 -0500
commit0d2fb782cac8a19df0c0d7715ad4cdab4c582e15 (patch)
treeb14047c5c088bdc2d605d5d45a059f83632c0b69 /CONTRIBUTING.md
parentdocs: update server_configurations.md (diff)
downloadnvim-lspconfig-0d2fb782cac8a19df0c0d7715ad4cdab4c582e15.tar
nvim-lspconfig-0d2fb782cac8a19df0c0d7715ad4cdab4c582e15.tar.gz
nvim-lspconfig-0d2fb782cac8a19df0c0d7715ad4cdab4c582e15.tar.bz2
nvim-lspconfig-0d2fb782cac8a19df0c0d7715ad4cdab4c582e15.tar.lz
nvim-lspconfig-0d2fb782cac8a19df0c0d7715ad4cdab4c582e15.tar.xz
nvim-lspconfig-0d2fb782cac8a19df0c0d7715ad4cdab4c582e15.tar.zst
nvim-lspconfig-0d2fb782cac8a19df0c0d7715ad4cdab4c582e15.zip
docs: update CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 322b123e..ff34e8b7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
## Requirements
-- [Neovim](https://neovim.io/) 0.5 or later
+- [Neovim](https://neovim.io/) 0.6 or later
- Lint task requires [luacheck](https://github.com/luarocks/luacheck#installation) and [stylua](https://github.com/JohnnyMorganz/StyLua). If using nix, you can use `nix develop` to install these to a local nix shell.
- Documentation is generated by `scripts/docgen.lua`.
- Only works on linux and macOS
@@ -9,6 +9,14 @@
The point of lspconfig is to provide the minimal configuration necessary for a server to act in compliance with the language server protocol. In general, if a server requires custom client-side commands or off-spec handlers, then the server configuration should be added *without* those in lspconfig and receive a dedicated plugin such as nvim-jdtls, nvim-metals, etc.
+## Pull requests (PRs)
+
+- To avoid duplicate work, create a draft pull request.
+- Avoid cosmetic changes to unrelated files in the same commit.
+- Use a [feature branch](https://www.atlassian.com/git/tutorials/comparing-workflows) instead of the master branch.
+- Use a **rebase workflow** for small PRs.
+ - After addressing review comments, it's fine to rebase and force-push.
+
## Adding a server to lspconfig
The general form of adding a new language server is to start with a minimal skeleton. This includes populated the `config` table with a `default_config` and `docs` table.