使用 GitHub

本 GitHub 教程以 DjangoGirls 如何贡献教程的基础上精心编写而成，以 CC 署名—相同方式共享 4.0 协议发布。

在本教程中，我们将以 Briefcase 仓库作为链接和参考的基础。

开始和先决条件

要为 BeeWare 做出贡献，您需要具备以下条件：

• 一个 GitHub 账户
• 如果是复杂的编辑，熟悉 Git 命令行基础知识或熟悉可讲将电脑上的编辑推送到 GitHub 的应用程序（Windows 和 Mac）。

Fork 仓库

首先，将 Briefcase 仓库 Fork 到您的个人 GitHub 账户：

编辑文档

简单更改

对于简单的更改，如错字更正，您可以使用 GitHub 在线编辑器：

• 打开 GitHub 上的本地 fork 页面、
• 进入任意章节的 README.rst 文件、
• 按 Edit 图标（笔）

即可直接在 github.com 上编辑该章节。

文档的各个页面使用 RST 语法编辑。

备注

保存更改并创建拉取请求，如下所述。

新代码和复杂更改

如果要添加新代码、扩展类或进行复杂的修改，您需要将代码拷贝到本地计算机。

使用操作系统的 GitHub 应用程序（如上所述）或命令行在本地获取仓库。您可以从自己的 GitHub 仓库 Fork 的首页获取地址：

git clone git@github.com:yourusername/briefcase.git

然后，创建一个 branch，将新的更改放在其中。将 branch 的命名为跟您将做的更改相关的名字。

git checkout -b update_documentation

对代码进行任何修改，确保这些修改经过测试，并保存在本地保存。

然后使用 git 提交更改，并将更改推送到远程 GitHub 仓库。

例如：

$ git status
On branch update_documentation
Untracked files:
  (use "git add <file>..." to include in what will be committed)

    README.rst

$ git add README.rst

$ git commit -m "Update README.rst documentation for Briefcase"
[update_documentation fe36152] Added gitbook screenshot
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 README.rst

$ git push
Counting objects: 11, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 266.37 KiB | 0 bytes/s, done.
Total 5 (delta 1), reused 0 (delta 0)
To git@github.com:yourusername/briefcase.git
   b37ca59..fe36152  update_documentation -> update_documentation

提交拉取请求 (PR, pull request)

完成修改后，您需要在 GitHub 上创建一个拉取请求。BeeWare 将收到拉取请求的通知，审核您的修改，并根据需要提出修改建议，然后拉取您的修改到主版本中。

在 GitHub 上自己的仓库中，按 Compare & pull request 键

填写为什么要做此更改的信息。审核人可以看到实际更改的细节，因此您无需重复更改内容。

然后按下 Create pull request。

GitHub 会通过电子邮件通知您后续流程。

---