mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-11-03 22:32:27 +08:00
docs: add code formatting guidelines to development documentation in English, Japanese, and Chinese
This commit is contained in:
@@ -58,6 +58,14 @@ When using `pnpm dev` to start locally, the environment variable `NEXT_PUBLIC_AP
|
||||
In production environments, the frontend will be precompiled into static files and provided by the backend, and the frontend will automatically access the backend address on the same domain.
|
||||
:::
|
||||
|
||||
## Code Formatting
|
||||
|
||||
The repository contains lint and format check workflows, and your code will be automatically checked when you push it. Please configure pre-commit to check your code locally before submitting.
|
||||
|
||||
```bash
|
||||
uv run pre-commit install
|
||||
```
|
||||
|
||||
## API Documentation
|
||||
|
||||
We will write API documentation in APIFox before developing each interface. Please refer to [API Documentation(Chinese)](https://ok52vhsenr.apifox.cn/).
|
||||
|
||||
@@ -58,6 +58,14 @@ npm run dev
|
||||
本番環境では、フロントエンドは静的ファイルにプリコンパイルされ、バックエンドによって提供され、フロントエンドは同じドメインのバックエンドアドレスに自動的にアクセスします。
|
||||
:::
|
||||
|
||||
## コードフォーマット
|
||||
|
||||
リポジトリにはlintとformatのチェックワークフローが含まれており、コードをプッシュすると自動的にチェックされます。pre-commitを設定して、コードをローカルで事前にチェックしてください。
|
||||
|
||||
```bash
|
||||
uv run pre-commit install
|
||||
```
|
||||
|
||||
## APIドキュメント
|
||||
|
||||
各インターフェースを開発する前に、APIFoxでAPIドキュメントを作成します。[APIドキュメント(中国語)](https://ok52vhsenr.apifox.cn/)を参照してください。
|
||||
|
||||
@@ -58,6 +58,14 @@ npm run dev
|
||||
生产环境中,前端会被预编译成静态文件,由后端提供服务,前端会自动访问同域的后端地址。
|
||||
:::
|
||||
|
||||
## 代码格式化
|
||||
|
||||
仓库中包含 lint 和 format 检查工作流,您推送代码后将被自动检查。请配置 pre-commit 来在提交时在本地提前检查代码。
|
||||
|
||||
```bash
|
||||
uv run pre-commit install
|
||||
```
|
||||
|
||||
## API 文档
|
||||
|
||||
我们在开发每个接口之前都会先在 APIFox 中编写接口文档,请查看 [API 文档](https://ok52vhsenr.apifox.cn/)。
|
||||
|
||||
Reference in New Issue
Block a user