Drools 文档(参与)

参与

咱们常常被问到“我如何参与”,幸运的是,答案很简单,只要写一些代码,而后提交 :) 这里没有你必需要跨越的障碍,也没有秘密的握手。咱们有一个很是小的“开销”,咱们请求容许可伸缩的项目开发,下面咱们将提供咱们要求的工具和“工做流”的概述,以及一些通常性建议。java

若是你写了一些好文章,别忘了写博客。git

注册jboss.org

登陆到jboss.org,你能够访问JBoss wiki、论坛和JIRA,进入https://www.jboss.org/ 并点击“注册”。github

sign_jbossorg.png

签署贡献者协议

你须要签署的惟一形式是贡献者协议,该协议经过web彻底自动化,以下图所示,“这为你的贡献创建了条款和条件,并确保源代码可以获得适当的许可”。web

https://cla.jboss.org/segmentfault

sign_contributor.png

经过JIRA提交问题

为了可以与核心开发团队进行交互,你将须要使用问题跟踪器JIRA,这确保了全部的请求都被记录下来并分配到一个发布计划中,全部的讨论都被捕获在一个地方,Bug报告,Bug修复,特性请求和特性提交都应该在这里,通常问题应在邮件列表中回答。工具

次要的代码提交,好比格式或文档修复,不须要建立相关的JIRA问题。单元测试

https://issues.jboss.org/browse/DROOLS测试

https://issues.jboss.org/browse/JBPMui

https://issues.jboss.org/browse/GUVNOR编码

submit_jira.png

Fork GitHub

在签署了贡献者协议并将你的请求提交给JIRA以后,你如今应该准备好编码 :) 建立一个GitHub账户,并fork任何Drools、jBPM或Guvnor存储库,fork会在你本身的GitHub空间中建立一个副本,你能够按照本身的进度进行操做,若是你犯了错误,别担忧,把它吹走,而后再用fork。注意,每一个GitHub存储库都为你提供了克隆(检出)URL,GitHub将为你提供特定于fork的URL。

https://github.com/kiegroup

fork_github.png

编写测试

在编写测试时,尽可能使它们最小化并保持自我控制,咱们更喜欢将DRL片断保存在测试中,由于这样能够更快地进行检查。若是它们是大量的规则,那么使用字符串是不实际的,因此不管如何都要将它们放在单独的DRL文件中,而不是从类路径加载。若是你的测试须要使用模型,请尝试使用那些已经存在于其余单元测试中的模型;例如Person,Cheese或Order,若是不存在具备所需字段的类,请在添加新类以前尝试更新现有类的字段。

有大量的测试须要查看以得到一个想法,MiscTest是一个很好的起点。

https://github.com/kiegroup/drools/blob/master/drools-compiler/src/test/java/org/drools/integrationtests/MiscTest.java

unit_test.png

遵照正确的约定

当你提交时,确保使用了正确的约定,提交必须从JIRA问题id开始,例如JBRULES-220。这确保了提交经过JIRA被交叉引用,所以咱们能够看到在相同的位置为一个给定的问题提交的全部提交。在id以后,接下来是问题的标题,而后使用带有破折号的换行符来提供与此提交相关的附加信息,为你想要表达的每个单独的观点使用额外的新线条和破折号。你能够向同一个提交添加额外的JIRA交叉引用,若是它是合适的。通常来讲,尽可能避免在同一个提交中组合不相关的问题。

不要忘记从原来的主分支中从新定位本地分支,而后将你的提交推回到你的分支中。

jira_crossreferenced.png

提交pull请求

经过将代码从最初的master中从新构建并推送到你的我的GitHub区域,你如今能够以pull请求的形式提交你的工做,若是你在GitHub上查看你工做区域的页面顶部,你会看到一个“Pull Request”按钮,而后选择它将提供一个gui来自动提交pull请求。

而后,pull请求进入一个队列,供每一个人查看和评论,下面你能够看到一个典型的pull请求。pull请求容许进行讨论,并显示全部相关提交和每一个提交的差别,讨论一般涉及到代码审查,这些审查为改进提供了有用的建议,并容许咱们对代码的特定部分留下内联注释。若是咱们不直接合并,不要灰心,在接受pull请求以前,一般须要进行屡次修改,幸运的是,GitHub让返回代码变得很是简单,执行更多提交,而后将pull请求更新到你的pull请求到最新和最大。

咱们须要时间来回复pull请求,因此请耐心等待,随修复程序一块儿提交的测试一般会很快被应用,在咱们有时间提交修复程序以前,测试一般会一直进行下去。不要忘记不时地从新创建和从新提交你的请求,不然随着时间的推移,它会有合并冲突,而核心开发人员一般会忽略这些冲突。

submit_pull_request.png


上一篇:Drools 文档(介绍)

下一篇:安装和设置(core和IDE)

相关文章
相关标签/搜索