docs: 新人上手一页纸 + CONTRIBUTING 协作约定(团队接手准备)

- docs/新人上手.md:第一天路径(前置软件/取码/构建/eip4dev/起服务/前端/必读序/高频坑/红线)
- CONTRIBUTING.md:分支命名/--no-ff 合并/提交格式/质量门(TDD+全 reactor 绿+作者评审分离+转换器重转重导)/CI 现状/文档归档纪律(两仓通用)
- docs/README.md §2 登记两份新文档

配套(仓外):工作区根 README 刷新至 07-02(原停 06-11);eip4-web README 联调指引修正另仓提交;两仓本地已合并分支清理(platform 40/web 7,含 ai-agent worktree)+远端 8 个已合并分支删除

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
2026-07-02 08:15:57 +08:00
parent c6bfcebcad
commit 2f97124ba1
3 changed files with 122 additions and 0 deletions

38
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,38 @@
# 贡献约定(eip4-platform / eip4-web 通用)
> 新人先读 `docs/新人上手.md`(环境)与 `docs/架构设计.md`(红线)。本文只讲协作流程。
## 分支与合并
- **main 不直接提交功能代码**;从 main 拉分支,前缀语义:`feat/`、`fix/`、`docs/`、`chore/`、`deploy/` + 短横线主题(如 `feat/approval-closure`)。
- 完成后 **`--no-ff` 合回 main 并 push**(保留合并节点,按批次可回溯),或走 Gitea Web UI 发 PR。合并后**删除本地/远端特性分支**。
- 一个分支一个主题;跨仓联动改动(platform+web)用同名分支便于对照。
## 提交信息
- 格式:`type(scope): 中文摘要`(如 `fix(report): 套打打印按选中行主键直接渲染`)。
- 正文写清:做了什么 / 为什么 / **验证证据**(单测数、live e2e 结论)。没验证的事不写「已完成」。
## 质量门(合并前自查清单)
1. **TDD**:新功能/修 bug 先写测试看它红,再实现变绿;禁止事后补「恒绿」测试。
2. **后端**:改动模块 `mvn -pl <模块> -am test` 绿;合并前全 reactor `mvn clean install` 绿(含 ArchUnit 边界规则)。
3. **前端**:`tsc -b` 干净 + `npx vitest run` 绿 + `npm run build` 成功。
4. **作者/评审分离**:合并前过一遍独立 code review(他人或 agent 对抗评审);涉及鉴权/SQL/脚本执行/DDL 的改动**必须加安全评审**。
5. **转换器改动**:重转重导后在运行库 live 验证(浏览器真渲染,不止单测),再合并。
6. **保真层改动**:默认禁止重写;确需改(如安全修)须登记 `docs/迁移手册.md` 并跑对拍回归。
## CI
- `.gitea/workflows/ci.yml`(构建+测试)与 `parity-nightly.yml`(夜间对拍)已就位,**待 Gitea 注册 act_runner 后生效**。
- runner 生效前,合并到 main 前请手跑 `bash scripts/ci.sh` 等价把关。
## 文档纪律
- 进度只回写 `docs/项目进度与路线-总览-*.md`(唯一权威);README 索引随之更新。
- 一次性 plan/报告完成后 `git mv` 入 `docs/归档/`,并同步改所有引用路径(grep 验证零断链)。
- 文档声明「已完成」必须附 git 证据(commit/merge 哈希)。
## 红线速查(详见 docs/架构设计.md 与 docs/新人上手.md §6)
JDK 21(严禁 26)|保真层不重写不改包名|DDL 走守卫单点|Flowable 不自动改表|AI 恒人审、对外严禁承诺全自动开发|amis 锁 6.13.0 本地 SDK。