mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-10-26 11:43:48 +00:00
docs: align domain docs with Chinese glossary
This commit is contained in:
@@ -16,6 +16,8 @@ triage 标签使用五个默认角色名作为标签字符串(needs-triage / nee
|
||||
|
||||
single-context:根目录一个 `GLOSSARY.md` + `docs/adr/`,按需惰性创建。见 `docs/agents/domain.md`。
|
||||
|
||||
`GLOSSARY.md` 和新建 ADR 的正文使用简体中文,代码标识符与必要的英文术语保留原文。已有 ADR 保留原文,不作语言迁移。
|
||||
|
||||
现状与已定设计以当前代码、`GLOSSARY.md` 和 `docs/adr/` 为准。仅 `GLOSSARY.md` 和 `docs/adr/` 持续维护为最新状态;判断当前实现时,以当前代码为事实依据。将设计文档或研究报告作为实现依据前,应先在代码中核实相关描述。
|
||||
|
||||
`docs/design/` 记录对应任务执行时的需求、设计与规格,仅作为历史参考,不代表最新代码现状。
|
||||
|
||||
+222
-123
File diff suppressed because one or more lines are too long
@@ -23,3 +23,9 @@ git config core.hooksPath .githooks
|
||||
```
|
||||
|
||||
启用后,`pre-commit` 只检查暂存区中 `ShadowsocksX-NG2/` 下的 `.swift` 文件:`swift format` 的结果写回暂存区、不修改工作区;SwiftLint 的 error 级违规拒绝提交,warning 仅提示。`Legacy/` 和其他文件跳过;没有 NG2 Swift 文件时直接放行。含有 NG2 Swift 文件但缺少工具时,提交检查失败。工具安装与版本见 [`ShadowsocksX-NG2/README.md`](ShadowsocksX-NG2/README.md)。
|
||||
|
||||
## 领域文档语言
|
||||
|
||||
本项目的 [术语表](GLOSSARY.md) 和新建 [架构决策记录(ADR)](docs/adr/) 使用简体中文,代码标识符与必要的英文术语保留原文;已有 ADR 保留原文,不作语言迁移。
|
||||
|
||||
AI 生成大量文档后,人与机器之间的沟通成为协作瓶颈:人的阅读、理解和审阅速度决定了文档能否有效推动开发。使用简体中文可以降低维护者的认知负荷,提高沟通与审阅效率。
|
||||
|
||||
Reference in New Issue
Block a user