Skip to content

Contributing

ChangYo edited this page Oct 26, 2026 · 3 revisions

贡献指南

这份 Wiki 的目标,是让开发者只读这里就能写出校园工具。内容标准有三条:可执行、可验证、不过时。

可以贡献的内容

  • 新平台或新接口的实测记录。
  • 现有页面的字段、端点和常见问题修正。
  • 过期内容的复核与废弃标记。
  • 场景食谱、最小示例、错误处理。
  • 文档结构、链接和排版改进。

不接受的内容:

  • 抢课、抢场馆、跑步造假、验证码绕过、账号共享、批量抓取。
  • 真实 Token/Cookie/学号/姓名/邮件正文/成绩。
  • 没有证据的「听说」「可能」「一般来说」。

页面契约

这是全站唯一一份页面契约;Atlas 只负责指到这里,不再维护第二份列表。

平台手册页至少包含:

> 平台 | 认证 | 数据方向 | 难度 | 最后验证 | 证据等级

## 0. 要点:可获取 / 前置 / 注意
## 1. 数据清单:对象 × 字段 × 粒度 × 历史 × 权限
## 2. 认证与前置条件
## 3. 端点表:method / path / 参数 / 返回 / 认证
## 4. 字段与语义:枚举、时间、ID、关联
## 5. 分页、限流、错误
## 6. 写操作与副作用(没有就删)
## 7. 常见问题:现象 / 原因 / 处理 / 证据 / 日期
## 8. 最小可运行示例
## 9. 已过时 / 不要用(没有就删)
## 10. 验证记录与来源

硬性要求:

  • 删掉所有外链后,本页仍能完成一次请求/解析。
  • 每个端点有 method/path/auth/params/returns。
  • 每个常见问题有现象、原因、处理、证据和日期。
  • 没有「可以构建的服务」式产品设想;需要时写进食谱。
  • 站内链接用相对链接。
  • 平台页顶部有「最后验证」;非平台页(入口/实践/食谱/附录)在页脚或「变更记录」写「最后复核」。
  • 平台页可以在标准顺序里增加平台特有的子节,但不要打乱编号;缺的节写「不适用」,不要静默省略。

证据要求

按阅读约定与证据等级标:

  • [官方]:附链接 + 访问日期。
  • [实测]:写日期、账号权限范围、样本量、请求/响应要点。
  • [社区]:附仓库/文章 + 它验证了什么。
  • [待验证]:只进待验证清单,不写成事实。

一个 PR 只改一个主题。不要在一次提交里混「新增页面 + 重排全站 + 修错别字」。

命名与链接

  • 页面文件名用 ASCII,PascalCase 或 kebab-case:Canvas、Classroom-Video、Recipe-Calendar。
  • 页面 H1 用中文。
  • 站内链接:[Canvas](Canvas);不要写死 GitHub 绝对地址。
  • 外部链接只作为脚注,挂在它支持的那句话后面;不要建「参考资料」大清单。
  • 页面重命名时保留旧页 stub,避免外部收藏 404。

怎么验证一个接口

  1. 只读优先:先用 GET / 列表 / 详情,不要一上来写。
  2. 最小请求:只带必要 header/参数;不要复制整个浏览器请求。
  3. 记录证据:方法、路径、状态码、关键响应字段、日期、账号权限。
  4. 两次确认:至少两次独立请求,排除偶发。
  5. 脱敏:删掉 Token、Cookie、学号、姓名、正文。
  6. 写操作:先在自己的测试对象上做;能撤销的先确认撤销路径。
  7. 失败也记录:403/404/空响应同样是知识,写清楚「什么情况下不工作」。

评审清单

  • 页面契约完整(至少 0/1/2/3/4/5/7/8/10)。
  • 每个结论有证据标签和日期。
  • 没有外链依赖也能完成核心任务。
  • 没有真实凭据/个人数据。
  • 没有抢课/抢场馆/造假/验证码绕过。
  • 站内链接是相对链接,且目标页存在。
  • 新页面已加入 _Sidebar.md。
  • 过期内容已移到已废弃接口或标 stale。
  • 代码示例能跑(至少语法正确、依赖写明)。

发布流程

当前 Dela.wiki/ 是唯一真源,也是 GitHub Wiki 的发布仓库:

  • Dela.wiki/:直接编辑;提交并 push 后即发布。
  • 产品仓库当前没有同步的 Dela/wiki/ 副本;不要按旧路径找文件。

发布步骤:

  1. 在 Dela.wiki/ 改,按上面的页面契约自检。
  2. 运行 git -C Dela.wiki diff --check,确认没有空白错误。
  3. 提交,git -C Dela.wiki push origin master。
  4. 打开对应页面,确认渲染、站内链接和代码块正常。

如果以后恢复产品仓库镜像,再按「编辑源 + 发布副本」双份流程同步,并在两边逐文件比对;恢复前不要在两处各改一份。

风格

  • 结论先行;一段只讲一件事。
  • 用表格承载字段/端点/对比;用代码承载协议细节。
  • 中文为主,字段名/端点/错误码保持英文原样。
  • 不写「众所周知」「显然」「一般来说」;写条件、写证据。
  • 不写「本产品」「我们的愿景」;写「你可以怎么用」。
  • 代码示例只写当前场景需要的错误处理,不写通用框架。

废弃策略

  • 接口变了:更新页面 + 页面底部「变更记录」加日期和变化。
  • 接口死了:移到已废弃接口,写最后可用日期、现象、替代。
  • 不要直接删除历史。废弃页记录当前不再推荐的路径;历史事实仍保留在页面变更记录中。

联系

  • 发现接口变化:开 Issue,带上请求/响应/日期/权限范围。
  • 想认领待验证项:在待验证清单里选一条,按上面的验证流程做。
  • 安全问题:不要在公开 Issue 里贴 Token/Cookie;先私下联系维护者。

最后复核:2026-10-26。

Clone this wiki locally