如何提交问题修复/功能/修补程序到 Toolkit 中?

我们欢迎 Toolkit 社区的贡献!如果您有或许可行的方法修复发现的某个问题,或者执行了一项您认为我们应该包含的功能,欢迎您按照下面的指导原则,通过适当渠道反馈给我们。

联系我们

我们鼓励您联系我们,共同讨论您的开发构想或要修复的问题。我们也许能提供有用的信息为您指引正确的方向,或者帮助您避免很多不必要的工作。最重要的是,我们喜欢了解用户想要构建什么,他们如何使用 Toolkit,以及我们如何使它变得更出色。

Fork 位于 GitHub 上的库

大多数 Toolkit 插件、应用和框架的代码都公开在 GitHub 上开发。您可以将要修改的库从 GitHub 上 Fork 到您的本地环境。

进行更改

在本地的一个分支上进行开发,然后在您自己的环境中测试,直到确信应用可以提交给我们。尽量与现有代码库的风格保持一致。保证您的更改专注于实现您的目的。例如,如果您是要修复 3 行代码中的某个错误,那么就不要试图修改整个文件中的空格问题。否则 Toolkit 小精灵会发飙的。

注释!

务必添加详细的注释,说明您要做什么以及为什么这样做。请记住,可能会有其他像您一样的用户以后会 Fork 此库,他们需要了解您的代码的用意和原因。注释要清楚,但也不要过度注释。:)

测试

请记住,其他用户会有各种各样的环境和变量,并且可能与您工作室的配置不尽相同。Toolkit 会尽可能减少这类问题给用户造成的影响,但是不同用户的环境总会有些差异。 例如:

  • 您的代码是否能在 OS X、Windows 和 Linux 上同样正常运行?
  • 代码是否能在某个软件的所有支持版本中正常运行?
  • 无论用户从终端、SG Desktop、Shotgun 还是自己的自定义应用中启动代码,代码是否都能一样运行?

创建 Pull 请求

一切准备就绪后,您可以使用 Push 操作将更改上传回 GitHub,并创建 Pull 请求。您的 Pull 请求应详细全面,说明您的代码有何用意,以及为何需要这些更改。撰写这些内容时,请考虑到那些初涉这个领域、对这方面代码知之甚少的用户。大家会看到您的 Pull 请求,其他用户也会很高兴能够理解您条理清晰的说明!

然后呢?

我们会在有时间时审核您的 Pull 请求。我们很可能会给出意见和建议,并询问您一些有关代码或用例的问题。我们也可能会将请求退回,并请您进行更改。请不要因此生气!我们欢迎大家提出自己的方案,但是也深知问题怎样才能得到解决。我们每天都在与代码打交道,因此也知道并非每个人都能提交完美的代码。 

审核完代码后,如果我们接受您的 Pull 请求,会安排对您的代码进行 QA,然后将它合并到我们的库,并安排在某个时间发布。具体的时间安排会受许多因素的影响。因此请耐心等待。

另外,我们还可能礼貌地拒绝您的 Pull 请求。同样,请不要生气。我们由衷感谢您做出的所有努力和贡献。有很多因素可能导致您的请求被拒。但是,如果您遵循上面的指导原则,一般不会出现这种情况。 

如果您有任何疑问,请发送电子邮件至:toolkitsupport@shotgunsoftware.com

关注

0 评论

登录写评论。