GitHub Guidelines

The following text is a partial translation of the original English article, performed by ChatGPT (gpt-3.5-turbo) and this Jekyll plugin:

本手册介绍了在GitHub上托管的XDSD项目的工作流程。您在GitHub分配给您一个问题时开始工作。接下来,您将收到一条来自项目经理的消息,其中包含问题编号、标题、描述以及预计的工时预算(通常为30分钟)。

如果您不同意预算分配,请毫不犹豫地要求增加。一旦您对预算感到满意并理解工作范围,请在回复工单时表示,并开始工作。请注意,超出预算时间的工作将不会得到支付。

即使你是开发团队的一员,也没有在GitHub上对仓库进行写权限。因此,为了贡献更改,你应该将仓库分叉到自己的GitHub账户中(创建一个私有副本),进行所需的更改,然后通过“拉取请求”提交进行审核。

在你提交拉取请求进行审核后,仓库所有者会将你的更改合并到主仓库中。这是我们保护主要开发流程免受意外损坏的方式。

本文解释了如何分叉一个仓库:分叉一个仓库

这篇文章解释了如何在计算机上下载和安装GitHub:设置Git

最后,不要忘记将你的私有SSH密钥添加到GitHub:生成SSH密钥

一旦你将我们的存储库分叉到你的账户中,将其克隆到你的计算机上,然后检出master分支。例如:

现在,是时候创建分支了(123是你要处理的 GitHub 问题的编号,也是分支的名称)。

按照惯例,我们使用与您正在处理的分支和问题相同的名称。

所有与任务相关的问题都应该在GitHub的问题中讨论。对于GitHub的问题,我们不使用电子邮件、Skype、电话或会议。所有问题都应该直接在GitHub的问题中提问。

如果有什么不清楚或需要帮助的地方,请毫不犹豫地提交新的问题。接到一个可能无法实现的任务是非常常见的。不要惊慌。这通常发生在你刚加入一个项目时,还没有足够的信息。如果这种情况发生了,请不要试图自己解决问题或发现问题。

对于这种情况,有一个经验法则:“如果有什么不清楚的地方,那是我们的错,而不是你的错。”因此,如果你不理解项目设计,那就是项目设计者的错。

提交一个错误报告,请求解释一个设计概念。你将会得到报酬,并且你在回复中收到的信息将会被分享给所有其他开发人员。

阅读这篇文章:Bugs Are Welcome。

不要期望任何人来帮助你。你唯一的帮助来源就是源代码本身。如果代码无法解释你所需知道的一切,那就是一个bug,必须报告。

使用文本编辑器或集成开发环境进行必要的更改。将更改提交是一个良好的做法,一旦您完成更改就立即进行提交。不要在提交更改之前积累大量的更改。

如果您对工作范围有疑问,请在 GitHub 的问题中发布并等待答复。如果您认为现有代码需要改进,请毫不犹豫地提交新的问题到 GitHub。

不要试图在一个分支中修复所有问题;让其他程序员负责处理它们。

在GitHub中使用以下文章中的过程创建一个拉取请求:using-pull-requests

将其编号发布在原始问题中并等待反馈。

过一段时间,你的拉取请求将由项目团队中的某人进行审查。在很多情况下,你可能会收到一些负面评论,并且你将需要修复与这些评论相关的所有问题。在你的更改满足审查者之前,你的拉取请求不会合并到master分支中。

要对审查者有耐心,并仔细听取他的意见。然而,不要认为你的审查者总是对的。如果你认为你的更改是有效的,请坚持要求其他人审查它们。

在你对分支进行所需的更改后,不要忘记通过在问题中发布一条针对他/她的消息来通知审查者。在每一轮审查-修复循环中都要做同样的事情:要求审查者再次查看你的代码。如果没有这样的通知,你的拉取请求可能会在静默中停留更久。

当一切对审核人员来说都看起来很好时,他会通知我们的自动合并机器人。自动合并机器人将选择您的拉取请求并尝试将其合并到 master 分支中。由于各种原因,这个操作经常失败。如果合并失败,不论原因如何,您有责任确保您的分支能够成功合并。

如果由于与您的任务无关的测试失败而无法合并分支,请不要试图自行修复。相反,请将问题报告为一个新的错误,并等待其解决。

请记住,在您的分支被合并之前,您是没有被支付的。

当你的更改合并后,请返回到GitHub问题并要求作者关闭它。一旦该问题由项目经理关闭,你将在几小时内收到付款。

Translated by ChatGPT gpt-3.5-turbo/42 on 2023-12-27 at 10:39

sixnines availability badge   GitHub stars