ishangsf/DeepCodeGeniusWeb-vscode
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jinglei Ren 2023-09-28 00:21:14 +08:00 committed by GitHub
parent 56c4e9aca0
commit 813f1054e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -5,7 +5,7 @@
# DevChat Visual Studio Code Extension
**An effective, down-to-earth AI coding assistant that blends AI power and manual control.**
**The AI Coding Assistant Made Effective by Manual Control**
🛠️ No excessive automation, just right AI where it works.
@ -30,14 +30,14 @@
## What is DevChat?
DevChat is an open-source platform that empowers developers to leverage AI for code generation and documentation. We aim to go beyond simple code auto-completion and limited operations on code snippets. DevChat offers a highly *practical* and *effective* way for developers to interact and collaborate with large language models (LLMs).
DevChat is an open-source platform that empowers developers to more effectively integrate AI into code generation and documentation. DevChat aims to go beyond simple code auto-completion and limited operations on code snippets. DevChat offers a highly *practical* and *effective* way for developers to interact and collaborate with large language models (LLMs).
## Why DevChat?
While there are many AI coding tools available, we developed DevChat based on our practical insights from generating tens of thousands of lines of code. DevChat makes the following distinctive design choices:
- **Precise manual control over the context embedded in a prompt**. Precise control over context is the key to effective AI use. We find that most other "intelligent" or "automatic" tools tend to over-guess what a user needs to put into a prompt. That typically introduces more noise than LLMs can effectively manage.
- **A simple, extensible prompt directory**. This enables developers or teams to easily integrate their own prompt templates into DevChat, avoiding significant engineering effort or a steep learning curve. You don't need a complex framework to make AI work for you. All it takes is a standard editor operating on your filesystem.
- **A simple, extensible prompt directory**. Bring your own prompts, and build a library of what works for you and your team. Easily integrate your own prompt templates into DevChat, avoiding significant engineering effort or a steep learning curve. You don't need a complex framework to make AI work for you. All it takes is a standard editor operating on your filesystem.
## Feature Overview
@ -45,7 +45,7 @@ While there are many AI coding tools available, we developed DevChat based on ou
Great output requires great input. To maximize the power of AI, DevChat assists you seamlessly to **provide the right context** to the AI.
- For instance, to generate test cases for a function, you can add to the prompt the function along with an existing test case. The test case serves as a useful reference for DevChat, enabling it to understand how to write a valid test case in your environment, thus eliminating the need for you to specify every requirement in your prompt.
- For instance, to generate test cases for a function, you can add to the prompt the function along with an existing test case. The test case serves as a useful reference for DevChat, enabling it to understand how to write a valid test case specific to your environment, thus eliminating the need for you to specify every requirement in your prompt.
![Add to context](https://github.com/devchat-ai/devchat-vscode/assets/592493/9b19c798-d06f-4373-8f8a-6a950c3a8ba5)
@ -53,7 +53,7 @@ Great output requires great input. To maximize the power of AI, DevChat assists
![Generate a commit message](https://github.com/devchat-ai/devchat-vscode/assets/592493/7bd34547-762c-4f97-b792-8d05a9eb1dcf)
- Program analysis can assist in building the necessary context. Suppose you want DevChat to explain some code to you. DevChat can perform better if it's aware of the dependent functions that the code calls. In this scenario, you select the target code to explain and add "symbol definitions" to the context (by clicking the plus button). DevChat will then generate a prompt that explains the target code, taking into account the dependent functions.
- Program analysis can assist in building the necessary context. Suppose you want DevChat to explain some code to you. DevChat can perform better if it's aware of the dependent functions that the code is calling. In this scenario, you can select the target code with DevChat to explain and add "symbol definitions" to the context (by clicking the plus button). DevChat will then generate a prompt that explains the target code, taking into account the dependent functions.
### Prompt Extension
@ -75,7 +75,7 @@ The `workflows` directory typically contains three subdirectories, `sys`, `org`,
└── prompt.txt
```
The `org` directory is useful for maintain team-wise conventions or requirements. Your team can share a Git repository to store prompts in `org`, and every team member can locally sync `~/.chat/workflows/org` with the repository. The `org` prompts will overwrite those in `sys`, while an individual developer can further customize them in `usr`.
The `org` directory is useful for cleanly maintaining team-wise conventions or requirements. Your team can share a Git repository to store prompts in `org`, and every team member can locally sync `~/.chat/workflows/org` with the repository. The `org` prompts will overwrite those in `sys`, while an individual developer can then further customize them in `usr`.
You can incorporate a template in your prompt by typing a "command" with the corresponding name in the DevChat input. Type `/` followed by the command name, as shown below. The `/`-separated path to the prompt directory corresponds to a `.`-separated command name. For instance, if you want to embed the 'prompt.txt' file located in `path/to/dir` into your current prompt, you should type `/path.to.dir` into the DevChat input field, along with the other content of the prompt. Note that `sys`, `org`, or `usr` do not need to be included in a command name. DevChat will first look up the corresponding path under `usr`, then `org`, and finally `sys`.
@ -84,19 +84,21 @@ You can incorporate a template in your prompt by typing a "command" with the cor
## Quick Start
> Chinese: [中文安装配置指南](https://zh.devchat.blog/devchat-vscode-installation-guide).
- Install Python 3.8 or later and ensure it's added to your system path. Verify the installation by opening the terminal and running `python --version`.
- Install Git and ensure it is added to your system path. Verify the installation by opening the terminal and running `git --version`.
- Install [Visual Studio Code](https://code.visualstudio.com/download).
- Open the Extensions view (⇧⌘X), search for DevChat, and install the extension:
&nbsp; &nbsp; <img width="220" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/c30f76fe-321a-4145-88fa-a0ef3d36bde5">
- Click on the DevChat icon in the status bar. If the API key is not set, DevChat will prompt you to enter it. Simply input your OpenAI's key.
- Click on the DevChat icon in the status bar. If the API key is not set, DevChat will prompt you to enter it. Simply input your OpenAI's key (DevChat's keys are for users having no OpenAI keys).
&nbsp; &nbsp; <img width="400" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/56f261c0-3aae-4df6-b699-c9e757bd91c1">
&nbsp; &nbsp; <img width="400" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/172ae656-a3ea-45c9-8b67-9bba1added1a">
- We recommend dragging the DevChat logo from the left sidebar to **the right sidebar** to avoid overlapping with the Explorer.
> Chinese Instructions (DevChat is global!): [中文安装配置指南](https://zh.devchat.blog/devchat-vscode-installation-guide).
## Community
- Join our [Discord](https://discord.gg/9t3yrbBUXD)!
@ -104,7 +106,7 @@ You can incorporate a template in your prompt by typing a "command" with the cor
## What is Prompt-Centric Software Development (PCSD)?
- The traditional code-centric paradigm is evolving.
- The traditional code-centric paradigm is evolving. Stay ahead of the curve with DevChat.
- Write prompts to create code. Transform prompts into all the artifacts in software engineering.
@ -126,6 +128,6 @@ Issues and pull request are welcome:
## Contact Information
hello@devchat.ai
Email: hello@devchat.ai
We are creators of [Apache DevLake](https://devlake.apache.org/).