mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-10-29 13:43:49 +00:00
Qiu Yuzhou
a31e2fa4bf
App/ 按分层、Domain/ 按主题组织，两个根层只放子目录、不放平铺文件；边界由 Tests/SkeletonTests.swift 的守卫正面圈定断言，而不是禁令加豁免登记。 ADR-0029 只记录组织原则本身：分层与主题划分的依据（Domain 主题名取自 GLOSSARY.md 的章节划分）、四条被否决的备选（平铺加豁免登记、feature-first、 Domain 照搬分层、守卫锁定目录集合），以及两条在代码里不可见的 XcodeGen 约束和跨进程契约按文件引用的代价。 ADR 不维护目录与文件清单——清单由 ShadowsocksX-NG2/README.md 的工程结构 一节维护，避免记录随事实漂移。 project.yml 的两处分层注释与 README 的工程结构一节各加一处引用：前者按该 文件既有写法引用编号，后者用完整链接。
ShadowsocksX-NG
🚧 重新实现进行中 —— 本仓库正在使用现代技术栈重写 ShadowsocksX-NG macOS 客户端。
新工程不再通过 git 子模块在仓库内构建依赖，而是直接复制上游项目发布好的可执行文件，以简化构建流程。
目录结构
.
├── ShadowsocksX-NG2/ # 新工程：现代化重写版本（开发中）
└── Legacy/ # 旧版工程完整源码，仅供参考，不保证可构建
旧版工程的功能说明与使用文档见 Legacy/README.md。
开发钩子
新 clone 后，在仓库根目录启用 Git hooks：
git config core.hooksPath .githooks
启用后，pre-commit 只检查暂存区中 ShadowsocksX-NG2/ 下的 .swift 文件：swift format 的结果写回暂存区、不修改工作区；SwiftLint 的 error 级违规拒绝提交，warning 仅提示。Legacy/ 和其他文件跳过；没有 NG2 Swift 文件时直接放行。含有 NG2 Swift 文件但缺少工具时，提交检查失败。两关都把「工具没能执行」与「查出问题」分开报告：看到「执行失败」应查工具与配置环境，而不是去改代码。工具安装与版本见 ShadowsocksX-NG2/README.md。
领域文档语言
本项目的 术语表 和新建 架构决策记录（ADR） 使用简体中文，代码标识符与必要的英文术语保留原文；已有 ADR 保留原文，不作语言迁移。
AI 生成大量文档后，人与机器之间的沟通成为协作瓶颈：人的阅读、理解和审阅速度决定了文档能否有效推动开发。使用简体中文可以降低维护者的认知负荷，提高沟通与审阅效率。