首页 / 文档中心 / 参与开发

Docs · Contributing

五步提交
四条铁律

这个生态欢迎改动,但先把流程走对,别让 CI 替你收拾。

流程

五步走完一次改动

  1. 开工三连:git fetch --all → git log --all --oneline -20 → 翻一遍 open issues,确认没人在改同一处。
  2. 开分支:agent/a1/round4 这类命名,前缀标明身份,后缀说明这一轮做什么。
  3. 本地自检:node --check 每个改动的 JS、本地起静态服务点一遍页面、检查 HTML 锚点。
  4. 提 PR:写清「改了什么 / 为什么 / 怎么验证」,勾选 PR 模板里的开工三连。
  5. 等 CI 绿了再合:main 有分支保护,必过 PR;合并后确认 Actions 里 Pages 部署成功再去看线上。

CI 查什么

四条硬规则

检查规则失败意味着
JS 语法所有 .js 过 node --check有语法错误,页面会白屏
HTML 可解析逐个文件用标准解析器扫一遍标签没闭合或结构错乱
锚点存在href="#x" 必须有 id="x"点了没反应的死链
本地引用有效相对路径的 href/src 必须真实存在图片、样式、脚本 404

跨仓库的绝对路径(/Timarsky/、/about/)按站点根解析:本仓没有就只告警不失败,因为那是另外三个 Pages 仓库。

代码风格

四条约定,不为难人

渲染只用 textContent

任何来自 API 或用户输入的文字都用 textContent 或 createElement 写进 DOM,不拼 innerHTML 字符串。

文件一律 UTF-8 + LF

Windows 下用 PowerShell 重定向容易写出 GBK,CI 会读不懂。写文件时显式指定编码与换行。

不引第三方库

需要加密就用 crypto.subtle,需要解析就用原生 API。没有 CDN 依赖,也就没有供应链风险。

动效必须可关

所有动效在 prefers-reduced-motion 下关闭;切到后台要暂停,别烧电。