Skip to content

Commit 76940bb

Browse files
author
Zhe Yu
committed
add logging to CONTRIBUTING.md
1 parent 538394e commit 76940bb

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Test and Coverage](https://github.com/Davidyz/VectorCode/actions/workflows/test_and_cov.yml/badge.svg)](https://github.com/Davidyz/VectorCode/actions/workflows/test_and_cov.yml)
55
[![pypi](https://img.shields.io/pypi/v/vectorcode.svg)](https://pypi.org/project/vectorcode/)
66

7-
VectorCode is a code repository indexing tool. It helps you write better prompt
7+
VectorCode is a code repository indexing tool. It helps you build better prompt
88
for your coding LLMs by indexing and providing information about the code
99
repository you're working on. This repository also contains the corresponding
1010
neovim plugin because that's what I used to write this tool.

docs/CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,17 @@ run tests, and `make coverage` to generate a coverage report. The testing and
2020
coverage report are also in the CI configuration, but it might still help to run
2121
them locally before you open the PR.
2222

23+
You may also find it helpful to
24+
[enable logging](https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#debugging-and-diagnosing)
25+
for the CLI when developing new features or working on fixes.
26+
2327
# Neovim Plugin
2428

2529
At the moment, there isn't much to cover on here. As long as the code is
2630
formatted (stylua) and appropriately type-annotated, you're good. I do have
2731
plans to write some tests, but before that happens, formatting and type
2832
annotations are the only things that you need to take special care of.
33+
34+
You may find it useful to
35+
[enable logging](https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#debugging-and-diagnosing)
36+
when you're poking around the codebase.

0 commit comments

Comments
 (0)