File tree Expand file tree Collapse file tree 3 files changed +21
-3
lines changed Expand file tree Collapse file tree 3 files changed +21
-3
lines changed Original file line number Diff line number Diff line change @@ -51,6 +51,9 @@ model output and reduce hallucination.
51
51
instructions to setup VectorCode to work with some other neovim plugins;
52
52
- the [ discussions] ( https://github.com/Davidyz/VectorCode/discussions ) where
53
53
you can ask general questions and share your cool usages about VectorCode.
54
+ - If you're feeling adanvturous, feel free to check out
55
+ [ the pull requests] ( https://github.com/Davidyz/VectorCode/pulls ) for
56
+ WIP features.
54
57
55
58
If you're trying to contribute to this project, take a look at [ the contribution
56
59
guide] ( ./docs/CONTRIBUTING.md ) , which contains information about some basic
Original file line number Diff line number Diff line change
1
+ # Before You Start
2
+
3
+ As much as I appreciate everyone who wish to contribute to this project, if
4
+ you want to submit a new feature/refactoring that is more than a few lines,
5
+ it'll be better if you open an issue or discussion before you start working.
6
+ This allows us to thoroughly exchange ideas before people invest too much time,
7
+ and will help me maintain the codebase in the long run.
8
+
9
+ # Technical Stuff
10
+
1
11
This project uses [ pre-commit] ( https://pre-commit.com/ ) to perform some
2
12
formatting and linting. If you're
3
13
contributing to this project, having it on your system will help you write code
@@ -6,7 +16,7 @@ You can also see
6
16
[ .pre-commit-config.yaml] ( https://github.com/Davidyz/VectorCode/blob/main/.pre-commit-config.yaml )
7
17
for a list of hooks enabled for the repo.
8
18
9
- # Python CLI
19
+ ## Python CLI
10
20
11
21
The development and publication of this tool is managed by
12
22
[ pdm] ( https://pdm-project.org/en/latest/ ) .
@@ -30,7 +40,7 @@ You may also find it helpful to
30
40
[ enable logging] ( https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#debugging-and-diagnosing )
31
41
for the CLI when developing new features or working on fixes.
32
42
33
- # Neovim Plugin
43
+ ## Neovim Plugin
34
44
35
45
At the moment, there isn't much to cover on here. As long as the code is
36
46
formatted (stylua) and appropriately type-annotated, you're good. I do have
Original file line number Diff line number Diff line change @@ -407,7 +407,12 @@ specs will be vectorised when you run `vectorcode vectorise` without specifying
407
407
files . This file has lower priority than ` .gitignore` , but you can override this
408
408
by the ` -f` flag . It also doesn' t assume `--recursive`, so if you want to add a
409
409
whole directory to this file, you can use `dir/**`, which matches all content
410
- of `dir/` recursively.
410
+ of `dir/` recursively.
411
+
412
+ > Note that the `include` spec only kicks in when you don' t
413
+ supply file paths when calling ` vectorcode vectorise` . If you want a rule to be
414
+ effective _whenever you vectorise some files_, you should use the ` exclude`
415
+ specs explained below.
411
416
412
417
Similarly, you can also create a ` project_root/.vectorcode/vectorcode.exclude`
413
418
file to denote any files that you want to exclude . This is useful when you have
You can’t perform that action at this time.
0 commit comments