11.6. 如何为本书贡献

    你可以在本书的GitHub代码库查看贡献者列表[1]。如果你希望成为本书的贡献者之一，需要安装Git并为本书的GitHub代码库提交pullrequest [2]。当你的pullrequest被本书作者合并进了代码库后，你就成为了本书的贡献者。

    本节介绍为本书贡献的基本Git操作步骤。

    下列操作步骤假设贡献者的GitHub ID为“astonzhang”。

    第一步，安装Git。Git的开源书里详细介绍了安装Git的方法[3]。如果你没有GitHub账号，需要注册一个账号 [4]。

    第二步，登录GitHub。在浏览器输入本书的代码库地址[2]。点击图11.20右上方红框中的“Fork”按钮获得一份本书的代码库。

    图 11.20 代码库的页面

    这时，本书的代码库会复制到你的用户名下，例如图11.21左上方显示的“你的GitHub用户名/d2l-zh”。

    第三步，点击图11.21右方的“Clone ordownload”绿色按钮，并点击红框中的按钮复制位于你的用户名下的代码库地址。按“获取和运行本书的代码”一节中介绍的方法进入命令行模式。假设我们希望将代码库保存在本地的路径之下。进入该路径，键入git clone并粘贴位于你的用户名下的代码库地址。执行以下命令：

    这时，本地的路径下将包含本书的代码库中的所有文件。

    第四步，编辑本地路径下的本书的代码库。假设我们修改了~/repo/d2l-zh/chapter_deep-learning-basics/linear-regression.md文件中的一个错别字。在命令行模式中进入路径，执行命令

    此时Git将提示chapter_deep-learning-basics/linear-regression.md文件已被修改，如图11.22所示。

    Git提示“chapter_deep-learning-basics/linear-regression.md”文件已被修改 图 11.22 Git提示“chapter_deep-learning-basics/linear-regression.md”文件已被修改

    确认将提交该修改的文件后，执行以下命令：

    其中的'fix typo in linear-regression.md'是描述提交改动的信息，也可以替换为其他有意义的描述信息。

    图 11.23 选择改动来源所在的代码库

    第六步，如图11.24所示，在标题和正文的文本框中描述想要提交的pullrequest。点击红框中的“Create pull request”绿色按钮提交pull request。

    描述并提交pull request 图 11.24 描述并提交pull request

    提交完成后，我们会看到图11.25所示的页面中显示pull request已提交。

    图 11.25 显示pull request已提交

    • 如果你觉得本书某些地方可以改进，尝试提交一个pull request。

    [1]本书的贡献者列表。

    [2] 本书的代码库地址。https://github.com/d2l-ai/d2l-zh

    [4] GitHub网址。