Skip to content

贡献指南

本仓库的变更分三类:内容勘误、新增内容、工程改进。

基本原则

  • 语言:正文用简体中文;专有名词保留英文(Godot、Steam、Game Jam)。
  • 文风:直白、具体,不堆修饰;参考现有文档的笔法。
  • 链接:新增链接先自行访问确认可达;CI 会定期复查。
  • 事实:数据、日期、政策类内容给出可核实的来源;不确定就标注。

内容勘误与新增

  1. 提 Issue(失效链接/过期信息用「内容勘误」模板,新内容用「新增内容」模板)。
  2. 或直接提 PR:小修直接改;大改先在 Issue 讨论。
  3. PR 需通过 markdownlint 与链接检查两项 CI。

新增一篇手册

  1. 在 docs/ 对应目录下创建 README.md(归属与结构见 docs/meta/design.md;先读它是硬性要求)。
  2. 首部写定位块(如 > **类型手册 · 第X辑**。定位:…)与配套阅读指引(参考现有手册的格式)。
  3. 同步更新 docs/README.md 与根 README.md 的导航。

工程改进

脚本(scripts/)、CI(.github/)的改动直接提 PR,附运行验证说明。

许可

提交内容即视为以 LICENSE 中的双许可(文档 CC BY-SA 4.0 / 代码 MIT)授权发布。