Skip to content

贡献树莓派文档

所有树莓派文档的资源都在线存储在一个名为 GitHub 的站点上,位于以下位置:

https://github.com/raspberrypi/documentation

尽管您将无法直接更改官方存储库中的文档,但是您可以查看所有源文件并了解所有内容的排列方式。源文件和文件夹遵循树莓派网站上的分层文档。

在进行任何更改之前,明智的做法是检查此处,以确定您的贡献是否可能被接受。

为了提交新的文档或更正的文档,您必须创建一个 GitHub 帐户(如果您还没有一个帐户),并将原始存储库"分叉"到您的帐户。您可以根据需要进行更改,将其保存在存储库中,然后对原始树莓派存储库进行"拉动请求"。然后,此拉取请求( PR )出现在树莓派存储库中,维护人员可以在该存储库中对其进行评估,进行复制编辑,并在适当时与正式存储库合并。

树莓派网站上显示的文档是从 GitHub 存储库生成的,并且大约每小时更新一次。

您将需要一个 GitHub 帐户来执行以下任何操作。

分叉存储库

这很容易。转到树莓派存储库,https://github.com/raspberrypi/documentation,然后查看页面的右上角。应该有一个标记为 Fork 的按钮,它将把存储库的副本派生到您自己的 GitHub 帐户中。

做出改变

现在,在您自己的存储库副本中,您可以更改或添加文件。文件格式为 GitHub Markdown,因此,新文件的后缀应为.md。在此处有 GitHub Markdown的描述。

要编辑文件,请首先在文件名树中找到该文件,然后单击它。这将以完全渲染的标记显示页面,并且在文档顶部(而不是页面顶部)的工具栏上是铅笔的小图标。这是编辑按钮。单击它,该文件将出现在 Github 编辑器中。现在,您可以编辑自己内心的内容。您可以单击"预览更改"以查看带有您所做编辑的完全渲染的文件。

页面末尾是一个名为"提交更改"的框。您可以将更改直接提交到自己的 master 分支,也可以创建一个新分支以用作拉取请求。使用主选项,因为这意味着您正在更改主副本。使用 branch 选项将在您自己的存储库中创建一个新分支,但是处理起来稍微复杂一点,因此这里不再赘述。如果在将更改推送到树莓派之前随时间进行了大量独立更改,则不妨调查分支选项。更新提交标题,然后输入更改说明。

选择提交更改将对您的主分支进行更改。现在,您需要进行更改并从中发出请求。

打开请求请求

这很容易。单击工具栏上的"拉请求"选项卡。然后,工具栏下方应有一个绿色按钮,标记为"新拉取请求"。单击它,然后会出现一个页面,要求您比较更改。该 PR 页面实际上位于树莓派 GitHub页面上,而不是在贡献者页面上,因为 PR 请求树莓派资源库维护者从贡献者的资源库中"提取"。左侧应该是" raspberrypi/documentation"存储库,分支应该是主存储库。右侧是 PR 的来源:您的 GitHub 帐户和您的 master 分支。在页面的更下方,您应该看到要在 PR 中拥有的提交列表,并在其下方显示实际更改。

如果您对创建 PR 很满意,请单击"创建请求请求"。

就是这样!现在,树莓派文档的 PR 列表中将包含您的条目。它将被读取,评估技术正确性,传递给副本编辑器以进行最终检查,最后合并到主文档树中。

这是通过 GitHub 进行贡献的非常快速的指南,但是它可以帮助您入门并让您有所作为!