From 5695157ab375f7d810a22cb6697df9b5ec87a548 Mon Sep 17 00:00:00 2001 From: Zhe Yu Date: Thu, 26 Jun 2025 10:43:47 +0800 Subject: [PATCH 1/2] docs: updates --- README.md | 3 +++ docs/CONTRIBUTING.md | 14 ++++++++++++-- docs/cli.md | 7 ++++++- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1383dfdf..e36fd2cd 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,9 @@ model output and reduce hallucination. instructions to setup VectorCode to work with some other neovim plugins; - the [discussions](https://github.com/Davidyz/VectorCode/discussions) where you can ask general questions and share your cool usages about VectorCode. + - If you're feeling adanvturous, feel free to check out + [the pull requests](https://github.com/Davidyz/VectorCode/pulls) for + WIP features. 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 diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 67d0df42..8a323ed4 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,3 +1,13 @@ +# Before You Start + +As much as I appreciate everyone who wish to contribute to this project, if +you want to submit a new feature/refactoring that is more than a few lines, +it'll be better if you open an issue or discussion before you start working. +This allows us to thoroughly exchange ideas before people invest too much time, +and will help me maintain the codebase in the long run. + +# Technical Stuff + This project uses [pre-commit](https://pre-commit.com/) to perform some formatting and linting. If you're contributing to this project, having it on your system will help you write code @@ -6,7 +16,7 @@ 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 +## Python CLI The development and publication of this tool is managed by [pdm](https://pdm-project.org/en/latest/). @@ -30,7 +40,7 @@ You may also find it helpful to [enable logging](https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#debugging-and-diagnosing) for the CLI when developing new features or working on fixes. -# Neovim Plugin +## 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 diff --git a/docs/cli.md b/docs/cli.md index 8d619b71..3b386cdb 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -407,7 +407,12 @@ specs will be vectorised when you run `vectorcode vectorise` without specifying files. This file has lower priority than `.gitignore`, but you can override this by the `-f` flag. It also doesn't assume `--recursive`, so if you want to add a whole directory to this file, you can use `dir/**`, which matches all content -of `dir/` recursively. +of `dir/` recursively. + +> Note that the `include` spec only kicks in when you don't +supply file paths when calling `vectorcode vectorise`. If you want a rule to be +effective _whenever you vectorise some files_, you should use the `exclude` +specs explained below. Similarly, you can also create a `project_root/.vectorcode/vectorcode.exclude` file to denote any files that you want to exclude. This is useful when you have From 5fce27fed5a6c89f52f212aa9de6e35102e975fe Mon Sep 17 00:00:00 2001 From: Davidyz Date: Thu, 26 Jun 2025 02:44:26 +0000 Subject: [PATCH 2/2] Auto generate docs --- doc/VectorCode-cli.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/VectorCode-cli.txt b/doc/VectorCode-cli.txt index 9d675453..510510fa 100644 --- a/doc/VectorCode-cli.txt +++ b/doc/VectorCode-cli.txt @@ -442,6 +442,11 @@ you can override this by the `-f` flag. It also doesn’t assume `--recursive`, so if you want to add a whole directory to this file, you can use `dir/**`, which matches all content of `dir/` recursively. + + Note that the `include` spec only kicks in when you don’t supply file paths + when calling `vectorcode vectorise`. If you want a rule to be effective + _whenever you vectorise some files_, you should use the `exclude` specs + explained below. Similarly, you can also create a `project_root/.vectorcode/vectorcode.exclude` file to denote any files that you want to exclude. This is useful when you have some files that should be tracked by git, but are not necessary to be indexed