读者的贡献 帮助我们改进本书。如果您发现拼写错误、过时的链接、您认为我们遗漏了引文、代码看起来不优雅或解释不清楚的地方,请回馈并帮助我们帮助我们的读者。虽然在普通书籍中,印刷运行之间的延迟(以及错别字更正之间的延迟)可以以年为单位来衡量,但通常需要数小时到数天才能将改进纳入本书。由于版本控制和持续集成 (CI) 测试,这一切都是可能的。为此,您需要向 GitHub 存储库提交拉取请求。当您的拉取请求被作者合并到代码存储库中时,您将成为贡献者。
23.6.1。提交小改动
最常见的贡献是编辑一个句子或修正拼写错误。我们建议您在GitHub 存储库中找到源文件并直接编辑该文件。例如,您可以通过查找文件按钮(图 23.6.1)搜索文件以找到源文件(markdown 文件)。然后单击右上角的“编辑此文件”按钮以在降价文件中进行更改。
完成后,在页面底部的“建议文件更改”面板中填写您的更改说明,然后单击“建议文件更改”按钮。它会将您重定向到一个新页面以查看您的更改(图 23.6.7)。如果一切顺利,您可以通过单击“创建拉取请求”按钮来提交拉取请求。
23.6.2。提出重大改变
如果你计划更新大部分文本或代码,那么你需要更多地了解本书使用的格式。源文件基于markdown 格式,通过d2lbook包提供了一组扩展 ,例如引用方程式、图像、章节和引用。您可以使用任何降价编辑器打开这些文件并进行更改。
如果您想更改代码,我们建议您使用 Jupyter Notebook 打开这些 markdown 文件,如第 23.1 节所述。这样您就可以运行并测试您的更改。请记住在提交更改之前清除所有输出,我们的 CI 系统将执行您更新的部分以生成输出。
某些部分可能支持多个框架实现。如果你添加一个新的代码块,请%%tab
在开始行使用 来标记这个块。例如,对于 PyTorch 代码块, 对于 TensorFlow 代码块,或者所有实现的共享代码块。您可以参考 < http://book.d2l.ai/user/code_tabs.html >`__ 包了解更多信息。%%tab pytorch
%%tab tensorflow
%%tab all
`d2lbook
23.6.3。提交重大变更
我们建议您使用标准 Git 流程来提交重大更改。简而言之,该过程的工作原理如图 23.6.2所示。
我们将引导您详细完成这些步骤。如果您已经熟悉 Git,则可以跳过本节。为了具体起见,我们假设贡献者的用户名为“astonzhang”。
23.6.3.1。安装 Git
Git 开源书籍描述了如何安装 Git。这通常通过 在 Ubuntu Linux 上运行,通过在 macOS 上安装 Xcode 开发人员工具,或使用 GitHub 的桌面客户端。如果您没有 GitHub 帐户,则需要注册一个。apt install git
23.6.3.2。登录 GitHub
在浏览器中输入本书代码库的地址。点击图23.6.3Fork
右上角红框内的按钮,复制本书的资源库。现在这是您的副本,您可以随意更改它。
现在,本书的代码库将被分叉(即复制)到您的用户名,如图23.6.4astonzhang/d2l-en
左上角所示 。
23.6.3.3。克隆存储库
要克隆存储库(即制作本地副本),我们需要获取其存储库地址。图 23.6.5中的绿色按钮 显示了这一点。如果您决定将此分叉保留更长时间,请确保您的本地副本与主存储库保持同步。现在只需按照安装中的说明开始。主要区别在于您现在正在下载自己的存储库分支。
# Replace your_github_username with your GitHub username
git clone https://github.com/your_github_username/d2l-en.git
23.6.3.4。编辑和推送
现在是编辑这本书的时候了。最好按照第 23.1 节中的说明在 Jupyter Notebook 中编辑它。进行更改并检查它们是否正常。假设我们修改了文件中的拼写错误 ~/d2l-en/chapter_appendix-tools-for-deep-learning/contributing.md
。然后您可以检查更改了哪些文件。
此时Git会提示文件 chapter_appendix-tools-for-deep-learning/contributing.md
已被修改。
mylaptop:d2l-en me$ git status
On branch master
Your branch is up-to-date with 'origin/master'.
Changes not staged for commit:
(use "git add ..." to update what will be committed)
(use "git checkout -- ..." to discard changes in working directory)
modified: chapter_appendix-tools-for-deep-learning/contributing.md
确认这是你想要的后,执行以下命令:
更改后的代码将位于您个人的存储库分支中。要请求添加您的更改,您必须为本书的官方存储库创建拉取请求。
评论
查看更多