使用 GitHub

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

在本教程中，我们将以 公文包 资源库作为链接和参考的基础。 链接和参考资料。

开始和先决条件

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

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

叉仓库

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

"Fork 按钮 alt="分叉按钮" />

编辑文档

简单更改

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

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

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

"编辑 "按钮 alt="编辑按钮" />

RST 语法用于编辑文件的各个页面。

备注

!以上截图可能无法反映 GitHub 仓库中的当前内容。实时版本库会不时更改。但是，提交拉取请求的流程保持不变。

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

新代码和复杂更改

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

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

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

然后，创建一个分支，将新的更改放在其中。将分支称为 分支的名称。

git checkout -b update_documentation

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

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

例如

$ git status
在分支 update_documentation 上
未跟踪文件：
  (使用 "git add <file>..." 添加将提交的文件）

    README.rst

git add README.rst

$ git commit -m "更新公文包的 README.rst 文档" [update_documentation fe36152] 已添加 gitbook 截图
[update_documentation fe36152] 已添加 gitbook 截图
 更改了 1 个文件，0 个插入(+)，0 个删除(-)
 创建模式 100644 README.rst

$ git push
清点对象：11 个，已完成。
最多使用 8 个线程进行 Delta 压缩。
压缩对象：100% (5/5)，已完成。
写入对象：100% (5/5), 266.37 KiB | 0 bytes/s, 已完成。
总计 5 (三角 1)，重复使用 0 (三角 0)
至 git@github.com:yourusername/briefcase.git
   b37ca59...fe36152 update_documentation -> update_documentation

提交拉取请求

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

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

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

然后按创建拉取请求。

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

---