chore: 更新开发环境配置与文档规范
- 切换代理目标至 wxm.behalo.cc 环境 - 添加脚本功能文档编写规范到 DOCUMENTATION_STANDARDS.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Showing
2 changed files
with
88 additions
and
2 deletions
| ... | @@ -23,10 +23,10 @@ VITE_PIN = | ... | @@ -23,10 +23,10 @@ VITE_PIN = |
| 23 | # 反向代理服务器地址 | 23 | # 反向代理服务器地址 |
| 24 | # VITE_PROXY_TARGET = https://oa.anxinchashi.com/ | 24 | # VITE_PROXY_TARGET = https://oa.anxinchashi.com/ |
| 25 | # VITE_PROXY_TARGET = http://behalo.onwall.cn/ | 25 | # VITE_PROXY_TARGET = http://behalo.onwall.cn/ |
| 26 | -VITE_PROXY_TARGET = http://oa-dev.onwall.cn/ | 26 | +# VITE_PROXY_TARGET = http://oa-dev.onwall.cn/ |
| 27 | # VITE_PROXY_TARGET = https://oa.behalo.cc/ | 27 | # VITE_PROXY_TARGET = https://oa.behalo.cc/ |
| 28 | # VITE_PROXY_TARGET = https://www.wxgzjs.cn/ | 28 | # VITE_PROXY_TARGET = https://www.wxgzjs.cn/ |
| 29 | -# VITE_PROXY_TARGET = https://wxm.behalo.cc/ | 29 | +VITE_PROXY_TARGET = https://wxm.behalo.cc/ |
| 30 | 30 | ||
| 31 | # PC端地址 | 31 | # PC端地址 |
| 32 | VITE_MOBILE_URL = http://localhost:5173/ | 32 | VITE_MOBILE_URL = http://localhost:5173/ | ... | ... |
| ... | @@ -395,6 +395,92 @@ git rm docs/xxx/FILE.md | ... | @@ -395,6 +395,92 @@ git rm docs/xxx/FILE.md |
| 395 | 2. 如果是任务文档,更新 `tasks/README.md` | 395 | 2. 如果是任务文档,更新 `tasks/README.md` |
| 396 | 3. 更新"快速查找"部分(如果适用) | 396 | 3. 更新"快速查找"部分(如果适用) |
| 397 | 397 | ||
| 398 | +### 5. 脚本功能文档(⚠️ 全局规则) | ||
| 399 | + | ||
| 400 | +**每次新增脚本功能之后,都必须编写关于该功能的 README.md 说明文档。** | ||
| 401 | + | ||
| 402 | +#### 适用范围 | ||
| 403 | + | ||
| 404 | +- ✅ 新增 Shell 脚本(如部署脚本、构建脚本) | ||
| 405 | +- ✅ 新增自动化工具脚本 | ||
| 406 | +- ✅ 新增数据处理脚本 | ||
| 407 | +- ✅ 新增开发辅助脚本 | ||
| 408 | +- ✅ 任何具有独立功能的脚本文件 | ||
| 409 | + | ||
| 410 | +#### 文档要求 | ||
| 411 | + | ||
| 412 | +每个脚本文档应包含: | ||
| 413 | + | ||
| 414 | +| 内容项 | 说明 | | ||
| 415 | +| ------------ | -------------------------- | | ||
| 416 | +| **功能描述** | 脚本的用途和目标 | | ||
| 417 | +| **使用方法** | 命令语法、参数说明、示例 | | ||
| 418 | +| **依赖环境** | 需要的工具、环境变量、权限 | | ||
| 419 | +| **配置说明** | 可配置项及其默认值 | | ||
| 420 | +| **注意事项** | 常见问题、限制条件 | | ||
| 421 | +| **更新日志** | 版本变更记录 | | ||
| 422 | + | ||
| 423 | +#### 文档位置 | ||
| 424 | + | ||
| 425 | +``` | ||
| 426 | +脚本所在目录/ | ||
| 427 | +├── script.sh # 脚本文件 | ||
| 428 | +└── README.md # 说明文档 | ||
| 429 | +``` | ||
| 430 | + | ||
| 431 | +或统一放置: | ||
| 432 | + | ||
| 433 | +``` | ||
| 434 | +docs/tools/ | ||
| 435 | +└── 脚本名称-说明.md # 统一脚本文档目录 | ||
| 436 | +``` | ||
| 437 | + | ||
| 438 | +#### 示例模板 | ||
| 439 | + | ||
| 440 | +```markdown | ||
| 441 | +# 脚本名称 | ||
| 442 | + | ||
| 443 | +## 功能描述 | ||
| 444 | + | ||
| 445 | +[简要说明脚本的功能和用途] | ||
| 446 | + | ||
| 447 | +## 使用方法 | ||
| 448 | + | ||
| 449 | +\`\`\`bash | ||
| 450 | + | ||
| 451 | +# 基本用法 | ||
| 452 | + | ||
| 453 | +./script.sh [参数] | ||
| 454 | + | ||
| 455 | +# 示例 | ||
| 456 | + | ||
| 457 | +./script.sh --env production | ||
| 458 | +\`\`\` | ||
| 459 | + | ||
| 460 | +## 参数说明 | ||
| 461 | + | ||
| 462 | +| 参数 | 类型 | 默认值 | 说明 | | ||
| 463 | +| ----- | ------ | ------ | -------- | | ||
| 464 | +| --env | string | dev | 环境名称 | | ||
| 465 | + | ||
| 466 | +## 依赖环境 | ||
| 467 | + | ||
| 468 | +- 工具:[列出需要的工具] | ||
| 469 | +- 权限:[需要的权限] | ||
| 470 | + | ||
| 471 | +## 配置说明 | ||
| 472 | + | ||
| 473 | +[配置项说明] | ||
| 474 | + | ||
| 475 | +## 注意事项 | ||
| 476 | + | ||
| 477 | +[常见问题和限制] | ||
| 478 | + | ||
| 479 | +## 更新日志 | ||
| 480 | + | ||
| 481 | +- v1.0.0 (YYYY-MM-DD): 初始版本 | ||
| 482 | +``` | ||
| 483 | + | ||
| 398 | --- | 484 | --- |
| 399 | 485 | ||
| 400 | ## 审查与发布 | 486 | ## 审查与发布 | ... | ... |
-
Please register or login to post a comment