refactor(nvim): Add CONTRIBUTING.md and refactor tests

Author: amitds1997

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing
+
+Thanks for contributing to `remote-nvim.nvim`. Your help means a lot!
+
+You can make contributions in the following ways:
+
+- **Mention it** to others if it has helped enhance/improve your workflow.
+- **Create GitHub issues** so that we know what we should work on building/fixing next.
+- **Raise PR** to fix bugs, improve documentation, add features, etc. The list goes on.
+- **Participate** in issues and discussions.
+
+## Getting started
+
+If you are setting the repo up, run `make install-hooks` to install the pre-commit hooks. These hooks should take care
+of most meta-things needed. Please make sure that the pre-commit checks and tests pass before raising the PR. In case,
+something is unclear, please raise the PR and we can take care of it then!
+
+### Pre-requisites
+
+- LuaLS (LSP server)
+- [lazydev.nvim](https://github.com/folke/lazydev.nvim/)
+- pre-commit
+
+Steps:
+
+1. Run `make install-hooks`: Installs all necessary pre-commit hooks. Post setup, it should take care of all meta-things
+   like formatting, linting, etc.
+2. Setup [lazydev.nvim](https://github.com/folke/lazydev.nvim/). If this is not your thing, setup
+   [.luarc.json](https://github.com/amitds1997/remote-nvim.nvim/blob/2d5158a/.luarc.json) file at the root
+   of the project.
+
+Once setup, make your changes!
+
+### Testing
+
+If you make any code changes, please add relevant test(s) post that. Once done,
+run `make clean-test` to run the tests. Make sure that the tests pass before creating the PR.
+
+### Commit message guidelines
+
+- For any features, bugs, etc. please use conventional commit message format. This helps in
+  automatic changelog generations.
+- For any minor changes that is not code related, it is OK if you do not use conventional commits.
+
+### Other information
+
+- Help file is generated from the README (which is not an ideal solution, but it helps reduce the workload). So,
+  update the README, if documentation needs to be updated.
+
+## Credits
+
+This documentation is heavily plaguarized from the `mini.nvim` CONTRIBUTING.md. So, thanks!

tests/init.lua

@@ -1,49 +1,8 @@
-local M = {}
-
-function M.root(root)
-  local f = debug.getinfo(1, "S").source:sub(2)
-  return vim.fn.fnamemodify(f, ":p:h:h") .. "/" .. (root or "")
-end
-
----@param plugin string
-function M.load(plugin)
-  local name = plugin:match(".*/(.*)")
-  local package_root = M.root(".tests/site/pack/deps/start/")
-  local uv = vim.fn.has("nvim-0.10") and vim.uv or vim.loop
-  ---@diagnostic disable-next-line: undefined-field
-  if not uv.fs_stat(package_root .. name) then
-    print("Installing " .. plugin)
-    vim.fn.mkdir(package_root, "p")
-    vim.fn.system({
-      "git",
-      "clone",
-      "--depth=1",
-      "https://github.com/" .. plugin .. ".git",
-      package_root .. "/" .. name,
-    })
-  end
-end
-
-function M.setup()
-  vim.cmd([[set runtimepath=$VIMRUNTIME]])
-  vim.opt.runtimepath:append(M.root())
-  vim.opt.packpath = { M.root(".tests/site") }
-  vim.opt.termguicolors = true
-  vim.env.XDG_CONFIG_HOME = M.root(".tests/config")
-  vim.env.XDG_DATA_HOME = M.root(".tests/data")
-  vim.env.XDG_STATE_HOME = M.root(".tests/state")
-  vim.env.XDG_CACHE_HOME = M.root(".tests/cache")
-
-  M.load("MunifTanjim/nui.nvim")
-  M.load("nvim-lua/plenary.nvim")
-  M.load("nvim-telescope/telescope.nvim")
-
-  require("remote-nvim").setup({
-    log = {
-      level = "debug",
-      max_size = 0,
-    },
-  })
-end
-
-M.setup()
+vim.env.LAZY_STDPATH = ".tests"
+load(vim.fn.system("curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua"))()
+
+require("lazy.minit").repro({
+  spec = {
+    { dir = vim.uv.cwd(), config = true },
+  },
+})

tests/remote-nvim/providers/provider_spec.lua

@@ -73,9 +73,10 @@ describe("Provider", function()
 
   describe("should handle setting workspace variables", function()
     local detect_remote_os_and_arch_stub, get_remote_neovim_version_preference_stub
-    local workspace_id = require("remote-nvim.utils").generate_random_string(10)
+    local workspace_id
 
     before_each(function()
+      workspace_id = require("remote-nvim.utils").generate_random_string(10)
       provider = Provider({
         host = provider_host,
         conn_opts = { "-p", "3011" },