From aa5f4f4ee10b2688fb37fa46215672441d5cd5d9 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Mon, 29 Apr 2024 17:59:07 +0200
Subject: docs: simplify CONTRIBUTING documentation #3132

- Deduplicate lint requirements.
- remove minimum neovim version as that is already specified by the
  README.
---
 CONTRIBUTING.md | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

(limited to 'CONTRIBUTING.md')

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 50c88055..f328abfc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,13 +1,12 @@
 ## Requirements
 
-- [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.
+- [Link requirements](#Lint)
 - Documentation is generated by `scripts/docgen.lua`.
   - Only works on linux and macOS
 
 ## Scope of lspconfig
 
-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.
+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)
 
@@ -107,10 +106,17 @@ with the commit body containing additional details.
 
 ## Lint
 
-PRs are checked with [luacheck](https://github.com/mpeterv/luacheck), [StyLua](https://github.com/JohnnyMorganz/StyLua) and [selene](https://github.com/Kampfkarren/selene). Please run the linter locally before submitting a PR:
+PRs are checked with the following software:
+- [luacheck](https://github.com/luarocks/luacheck#installation)
+- [stylua](https://github.com/JohnnyMorganz/StyLua).
+- [selene](https://github.com/Kampfkarren/selene)
+
+Please run the linter locally before submitting a PR:
 
     make lint
 
+If using nix, you can use `nix develop` to install these to a local nix shell.
+
 ## Generating docs
 
 GitHub Actions automatically generates `server_configurations.md`. Only modify `scripts/README_template.md` or the `docs` table in the server config Lua file. Do not modify `server_configurations.md` directly.
-- 
cgit v1.2.3-70-g09d2