跳到主要内容

此处介绍项目规范与贡献要求。

如何开始

本项目使用框架 Docusaurus,具体使用请参考文档

这是本项目 GitHub 仓库的链接。

最后,附上 Ray Tracing in One Weekend 原文链接。

  1. 取得仓库:git clone https://github.com/ilsao/RTW-Translation.git

  2. 使用 vscode 打开文件夹。

  3. 在终端中输入 npm start

  4. 新增或修改 RTW-Translation/docs/ 下的文件。注意,你不应该修改其他文件夹下的文件,除非你非常清楚自己在做甚么。

  5. 准备部属时,先将所有改动 push 到你的 branch。然后在终端中输入 npm run build,通过后 npm run serve

协作流程

  1. 对于每个章节,开一个新分支。命名规则:TL-[章节标题]

  2. 在更新分支前,确保此分支与 main 分支同步。

    • git fetch origin
    • git rebase main
    • git push -f
  3. commit 时,遵守以下规则:

    • 翻译文章:TL: [章节标题] <备注>
    • 修改框架或外观:<备注>
  4. 提 pr 时,应遵守:

Title: [TL] [章节标题] <备注>
---
# 进度

# 补充信息

注意,仅在 pr 内使用 简体中文,其余部分使用英文

语言

本项目使用简体中文作为第一部分的翻译语言,应该避免使用繁体中文专用语。

我制作了下表,帮助你校对两岸常见用语的差异:

英文繁体中文简体中文
program程式程序
library函式库
code程式码代码
debug除错调试
class类别
declare宣告声明
variable变数变量
function函式函数
argument引数参数
pointer指标指针
array阵列数组
memory记忆体内存
stack堆叠
string字串字符串
polymorphism多型多态
template样板模板
process行程进程
thread执行绪线程
return value回传值返回值
operator运算子运算符
constructor建构子构造函数
deconstructor解构子构析函数
real-time rendering即时显影技术实时渲染
computer graphics电脑图学计算机图形学