57 lines
2.9 KiB
Markdown
57 lines
2.9 KiB
Markdown
# 贡献与跨电脑协作
|
|
|
|
本仓库维护语言文档和作者手册。语言正文使用 guide，查询附录使用 appendices，研究、规则与模板使用 authoring。
|
|
|
|
## 开始阅读
|
|
|
|
首次参与先读 [AGENTS.md](AGENTS.md)、[endor-docs skill](authoring/SKILL.md)及目标章节的主要定义。每次改动从[作者手册](authoring/README.md)选择任务，查阅对应小节和注意事项，再按[工作流](authoring/workflow.md)完成修改。
|
|
|
|
任务页直接列出必读方法、规则、案例和注意事项，每次实际查阅后再编写。项目级 skill 入口与跨电脑使用见[说明](authoring/skill-usage.md)。
|
|
|
|
写作标准不改变语言设计稿的确定程度。提案确认需要明确的语言决定，不能仅凭修订文档或加入模板获得确认。
|
|
|
|
## 本地检查
|
|
|
|
默认人工核对主定义、文法、例子、链接和状态。只有用户明确要求执行检查时，才使用仓库保留的工具；它们依赖 Python 3.10 或更新版本的标准库：
|
|
|
|
```sh
|
|
python3 tools/check_docs.py
|
|
python3 -m unittest discover -s tools/tests -v
|
|
git diff --check
|
|
```
|
|
|
|
能力与限制见[工具说明](tools/README.md)。没有语言编译或执行工具时，只报告结构检查和人工核对，不宣称源码运行通过。
|
|
|
|
## Git 身份
|
|
|
|
远端为 [Endorphin-Document](https://gitea.entroia.com/Zayden-Jung/Endorphin-Document)。仓库 owner 与认证身份分开：所有 Codex Git 操作只使用 `codex-bot`，不得借用 owner 的账户、密钥或凭据。
|
|
|
|
提交作者在本仓库范围配置为：
|
|
|
|
```sh
|
|
git config --local user.name "Codex Bot"
|
|
git config --local user.email "codex-bot@gitea.entroia.local"
|
|
```
|
|
|
|
SSH 使用用户 git、端口 22222 和本机为 codex-bot 配置的专用密钥，并以 `-F /dev/null` 与 `IdentitiesOnly=yes` 隔离其他身份。各电脑需要自行取得 bot 授权并配置专用密钥；不把密钥、密码或 Authorization 头存进仓库。
|
|
|
|
远端的 SSH 地址为：
|
|
|
|
```text
|
|
ssh://git@gitea.entroia.com:22222/Zayden-Jung/Endorphin-Document.git
|
|
```
|
|
|
|
## 修改与交付
|
|
|
|
开始前保留其他作者的编辑。修改后核对主定义、例子、文法、目录与状态；用户明确要求提交时，再检查 Git 分支、未提交改动和暂存范围。
|
|
|
|
仅在用户授权时提交或推送，不强推覆盖远端，不附带启动测试或项目 hook。权限不足时保留本地工作，请用户为 codex-bot 授予权限，不切换账号。
|
|
|
|
交付报告使用中文，说明提交标识、推送状态、检查结果，以及每个修改文件的目的与内容。可以按共同目的分组，但新增、移动或删除文件也需要覆盖。
|
|
|
|
## 不入库的内容
|
|
|
|
个人编辑器状态、机器专用路径、环境秘密与认证材料不随文档同步。共享的是文本、相对链接、规则和验证流程，而不是某台电脑的会话或配置。
|
|
|
|
[语言文档入口](README.md) · [作者手册](authoring/README.md)
|