感兴趣参与框架建设的小伙伴请通过微信或者QQ联系 郭强 报名。

目的

  1. 针对框架中一些已经非常稳定的组件，需要进一步完善使用示例的中文文档。
  2. 通过Example代码的方式，既完善了文档，也同时在仓库中增加了代码示例、进一步完善了框架的单元测试覆盖率。

如何编写

  1. 第一步，拉取主库master分支代码。查阅源码方法以及注释，框架源码保证代码质量和可维护性，代码阅读起来赏心悦目。
  2. 第二步，写Example代码。关于如何编写Example代码请参考：代码示例
  3. 第三步，Example代码完成后提交PR到主库，经过一定时间的CodeReview后没有问题则会被合并到主库的master分支。
  4. 第四步，将Example代码完善到对应的官网中文文档中。中文文档以示例为主，可以有多个示例描述该方法如何使用，文档排版请参考：数据校验-校验规则

参考资料

  1. Example代码编写视频介绍：https://www.bilibili.com/video/BV1k44y1i7fM/

完善工作

Content Menu

  • No labels