当前位置: 首页 > 文档资料 > CatLib 中文文档 >

贡献指南

优质
小牛编辑
124浏览
2023-12-01

本文档描述了如何对框架提供贡献及框架,组件,文档,bug fixed的贡献情况。

缺陷报告

CatLib 强烈鼓励使用 GitHub 的 pull requests (以下简称PR),来提供缺陷报告。“缺陷报告”也可以通过一个包含失败断言的 pull requests 的方式提交。

如果你以文件的方式提交缺陷报告,你的问题应该包含一个标题和对该问题的明确说明,还要包含尽可能多的相关信息以及论证该问题的代码样板,缺陷报告的目的是为了让你自己和其他人更方便的重现缺陷并对其进行修复。

开发讨论

你可以在issue上提议新功能或者优化已有功能,如果是新功能的话请至少实现部分代码以便完成新功能开发。

Pull Request

  • 不要进行较大内容的PR , 除非它是一个全新的组件
  • 每个PR只做一件事情
  • 确保PR的代码能够通过编译
  • 提交PR时,请务必保证针对代码的所有测试都必须通过
  • 提交PR时,请务必记录好PR的原因
  • 提交的PR,请务必保证单元测试尽可能的覆盖(核心组件90%,常规组件75%)
  • 如果提交的PR不能完成覆盖,请描述其原因。
  • 所有的PR的单元测试都必须能在VS(MSTest)和Unity(NUnit)中运行
  • 请按照代码风格指南正确规范的编写代码

提交到的分支

  • 所有的 bug 修复应该被提交到最新的稳定分支,永远不要把 bug 修复提交到 master 分支,除非它们能够修复下个发行版本中才存在的特性。
  • 当前版本中完全向后兼容的次要特性也可以提交到最新的稳定分支。
  • 重要的新特性是要被提交到 master 分支的。
  • 如果你不确定是重要特性还是次要特性,请在calib.slackQQ群中咨询。

合并请求描述

合并请求描述需要附带下面表格,并完善表格中对应的信息:

QA
Branch?\<version>
Bug fix?\<yes \no>
New feature?\<yes \no>
Deprecations?\<yes \no>
Tests pass?\<yes \no \n/a>
License?\<license-name \n/a>

\<合并请求修改内容的描述>

框架设计者

组件贡献者

虚以待位

其他贡献者

最后更新:

类似资料

  • CatLib For ILRuntime 是基于 CatLib 和 ILRuntime 的热更新扩展包。 使用该扩展包,您可以轻松的让Unity项目支持热更新,并且可以像主工程那样使用CatLib框架。 特性 热补丁 : 允许使用热更新的代码来修复主工程代码中的BUG。 混合调用 : 在ILRuntime热更新项目和主工程中的调用是一致的,复杂的转换操作都将被框架层隐藏。 依赖注入 : 允许热更新

  • 企业级客户端架构方案,为您的项目提供可靠,高效,可持续的公共基础组件。依赖注入容器,标准库,远程客户端调试,客户端路由,云文件系统,加解密库,定时器... var logger = App.Make<ILogger>(); 2logger.Debug("hello world"); 关于 CatLib CatLib是为Unity3D开发的全栈开发框架,我们通过集成常见的开发组件来减少开发者们不必

  • 为CakePHP做贡献有多种方式。以下各节涵盖了各种可以为CakePHP做出贡献的方式: 文档 问题跟踪系统 代码 编码规范 向后兼容性指南

  • 简介 Fuel 是一个社群驱动的框架,并且开放来自任何认为他们可以改进框架或添加功能的人们, 来让框架到达更高水准的贡献。 有许多形式可以做到这一点,从写教学、编写和发布套件, 以促进成为 Fuel 的正式部分(核心、Orm、文档等……)。 贡献程式码 当你遭遇一个错误,或看到问题清单中你能或已解决的问题, 而且你想要将它贡献回框架。根据你所拉取(pull)正在运行的版本分支, 使用 GitHub

  • 我们非常欢迎您加入 Hexo 的开发。 ???? 开发 我们非常欢迎您加入 Hexo 的开发,这份文件将帮助您了解开发流程。 开始之前 请首先阅读《贡献者行为准则》,并确保您不会违反它。 请使用以下代码风格: 遵守 Google JavaScript 代码风格。 缩进使用 2 个空格。 不要把逗号放在最前面。 另外,Hexo 拥有自己的 ESLint 配置,因此请确保您的贡献能够通过 ESLint

  • 找到一个漏洞?有一个新的功能建议?想要对代码库做出贡献?请务必先阅读这些。 漏洞报告 你的代码不起作用,你确定问题在于Keras?请按照以下步骤报告错误。 你的漏洞可能已经被修复了。确保更新到目前的Keras master分支,以及最新的 Theano/TensorFlow/CNTK master 分支。 轻松更新 Theano 的方法:pip install git+git://github.c