From 49a017732b304137caed4095d7250b234d114c75 Mon Sep 17 00:00:00 2001
From: lzx <393768033@qq.com>
Date: Mon, 14 Apr 2025 16:32:28 +0800
Subject: [PATCH 1/2] v1 docs rename

---
 ...€æ±‚文档(v1).xlsx => v1.0.0_需求文档.xlsx} | Bin
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename v1/{需求文档(v1).xlsx => v1.0.0_需求文档.xlsx} (100%)

diff --git a/v1/需求文档(v1).xlsx b/v1/v1.0.0_需求文档.xlsx
similarity index 100%
rename from v1/需求文档(v1).xlsx
rename to v1/v1.0.0_需求文档.xlsx

From d5426fbd8dbd8cd7b7901d3a658b96fe20d8a8d8 Mon Sep 17 00:00:00 2001
From: lzx <393768033@qq.com>
Date: Tue, 15 Apr 2025 14:44:29 +0800
Subject: [PATCH 2/2] update

---
 document.md | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)
 create mode 100644 document.md

diff --git a/document.md b/document.md
new file mode 100644
index 0000000..b0bbf17
--- /dev/null
+++ b/document.md
@@ -0,0 +1,96 @@
+# 📦 代�与版本管�规范
+
+## 1. 版本一致性�求
+
+- 所有模�必须采用统一的版本�赖（如 go.mod�package.json 等）。
+- 版本�需�循 [语义化版本规范 (SemVer)](https://semver.org/lang/zh-CN/)，如：`v1.0.0`�`v1.1.0-beta`。
+- ��模�版本需��兼容，��许出现版本冲�。
+
+---
+
+## 2. 需求文档与�交代�对�
+
+- �交代�必须严格对应当�版本的需求文档。
+- �止�交未在需求文档中定义的功能代�或逻辑。
+- 建议�次�交记录中引用需求编�或链接。
+- �交时标注好本次�交的作用，例如：
+- update表示该�交为更新，�正��布，��用于版本回滚。
+- release表示正��布，�用于版本回滚。
+- fix表示修�bug，��用于版本回滚。
+---
+
+## 3. 版本�布�求
+
+- �布版本需�供对应测试报告（功能测试�回归测试�异常测试）。
+- 仅在测试报告审核通过�方��布版本。
+- 所有�布记录需归档并记录�更日志（详�第 6 节）。
+- 版本�布�为稳定版本，�止修改其代�。
+
+---
+
+## 4. 环境�建与部署�求
+
+- ✅ 开�环境与测试环境由开�/测试人员自行�建；
+- 🚫 生产环境�建需�供《部署说明文档》，通过审核�方�执行；
+- 建议本地化部署测试生产模拟环境；
+- 示例目录结构：
+  ```
+  /env
+    ├── dev.env
+    ├── test.env
+    └── prod.env
+  ```
+
+---
+
+## 5. 环境隔离规范
+
+- 所有代��数�库��置必须区分开��测试�生产环境；
+- 严���环境代�或数�交�使用；
+- 推�通过 `.env` 文件或�置中心隔离��环境�置项。
+
+---
+
+## 6. 上线与版本基线管�
+
+- �模�首次上线作为版本基线（如 `v1.0.0`）；
+- 多模��作时需�步约定接��数�结构；
+- 使用 `CHANGELOG.md` 文件记录版本更新内容。
+
+---
+
+## 7. README 规范（需包�以下内容）
+
+- ✅ 编译命令（示例）：
+  ```bash
+  go build -o ./bin/app main.go
+  ```
+- ✅ �动命令：
+  ```bash
+  ./bin/app --config ./configs/config.yaml
+  ```
+- ✅ 打包说明（如 Dockerfile�压缩包结构等）；
+- ✅ �置文件结构说明(其他如.conf�.ini�.json�.yaml等�置文件按照规范命�，并说明�置项�义和用途)：
+  ```yaml
+  server:
+    port: 8080
+  database:
+    host: localhost
+    name: project_db
+  ```
+- ✅ �项�置说明或链接到�置文档。
+
+---
+
+## 8. 数�结构与�始化�求
+
+- 所有数�库表结构必须�供�始化脚本：
+  ```
+  /db
+    ├── init.sql
+    └── migration/
+  ```
+- �止手动创建�删除�修改数�表和表结构，尽����赖人工�作数�库；
+- 推�使用自动�移工具（如 Flyway�Goose�gormigrate）进行结构�级控制。
+
+---
\ No newline at end of file