Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions doc/VectorCode-cli.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 12 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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/).
Expand All @@ -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
Expand Down
7 changes: 6 additions & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down