chore: add CONTRIBUTING.md

Author: Davidyz

README.md

@@ -58,6 +58,10 @@ and chat plugin available on VSCode and JetBrain products.
 - For neovim users, after you've gone through the CLI documentation, please refer to 
   [the neovim plugin documentation](./docs/neovim.md) for further instructions.
 
+If you're trying to contribute to this project, take a look at [the contribution
+guide](./docs/CONTRIBUTING.md), which contains information about some basic
+guidelines that you should follow and tips that you may find helpful.
+
 ## TODOs
 - [x] query by ~file path~ excluded paths;
 - [x] chunking support;
@@ -78,7 +82,7 @@ and chat plugin available on VSCode and JetBrain products.
   **Implemented project-level `.vectorcode/` and `.git` as root anchor**
 - [ ] ability to view and delete files in a collection (atm you can only `drop`
   and `vectorise` again);
-- [x] joint search (kinda, using codecompanion.nvim).
+- [x] joint search (kinda, using codecompanion.nvim/MCP).
 
 ## Credit
 

docs/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+This project uses [pre-commit](https://pre-commit.com/) to perform some
+formatting and linting that hasn't made its way into CI/CD. If you're
+contributing to this project, make sure you set it up before you make the commit. 
+You can also see 
+[.pre-commit-config.yaml](https://github.com/Davidyz/VectorCode/blob/main/.pre-commit-config.yaml) 
+for a list of hooks enabled for the repo.
+
+# Python CLI
+
+The development and publication of this tool is managed by 
+[pdm](https://pdm-project.org/en/latest/).
+
+Once you've cloned and `cd`ed into the repo, run `make deps`. This will call
+some `pdm` commands to install development dependencies. Some of them are
+actually optional, but for convenience I decided to leave them here. This will
+include [pytest](https://docs.pytest.org/en/stable/), the testing framework, 
+and [coverage.py](https://coverage.readthedocs.io/en/7.7.1/), the coverage
+report tool. If you're not familiar with pytest or coverage.py, you can run `make test` to
+run tests, and `make coverage` to generate a coverage report. The testing and
+coverage report are also in the CI configuration, but it might still help to run
+them locally before you open the PR.
+
+# Neovim Plugin
+
+At the moment, there isn't much to cover on here. As long as the code is 
+formatted (stylua) and appropriately type-annotated, you're good. I do have 
+plans to write some tests, but before that happens, formatting and type 
+annotations are the only things that you need to take special care of.