-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add CONTRIBUTING.md for VSCode (#2913)
* docs: add CONTRIBUTING.md for VSCode * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
- Loading branch information
1 parent
bbf4519
commit c9970bd
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# CONTRIBUTING | ||
|
||
## Development | ||
|
||
Thank you for considering contributing to Tabby VSCode Extension, to get started, use the following commands: | ||
|
||
```bash | ||
|
||
# Install dependencies | ||
pnpm install | ||
|
||
# Start VSCode in development mode, with the extension loaded | ||
pnpm dev | ||
|
||
# Start VSCode Webview in development mode, with the extension loaded | ||
pnpm dev:browser | ||
``` | ||
|
||
## Architecture | ||
|
||
On a high level the extension is divided into the following components: | ||
|
||
+---------------------+ | ||
| Tabby Server | | ||
+------------------+ | +-----------------+ | | ||
| VSCode Extension | ---->| | | | ||
+------------------+ | | Chat UI | | | ||
| | | | | | ||
| | +-----------------+ | | ||
| | | | ||
v | +-----------------+ | | ||
+------------------+ | | | | | ||
| Tabby Agent | ---->| API | | | ||
+------------------+ | | | | | ||
| +-----------------+ | | ||
+---------------------+ | ||
|
||
- **Tabby Server**: The server component of Tabby, responsible for managing user accounts, code completions, and chat functionality. | ||
- **Chat UI**: The web-based UI for Tabby Chat, which is embedded as a webview in the VSCode extension. It is distributed together with the Tabby Server. | ||
- **Tabby Agent**: The LSP server of Tabby, responsible for providing code completions and other language services to the VSCode extension. It communicates with the Tabby Server via the API. For VSCode, the Tabby Agent is a library, thus it is embedded in the extension. |