贡献代码

1. 我要参与

如果你存在:

  1. 使用中发现平台类库存在bug
  2. 使用中发现平台功能不足,需要扩展
  3. 工作中积累了一些通用常用的类库,想分享出去,集大家之力参与使用完善。

秉承公司核心价值观"创造价值 · 共享共赢",诚邀你为“构建平台”添砖加瓦,贡献自己的一份力量。

2. 如何参与

2.1. 修改已有类库

  1. 登陆公司gitlab平台,进入分组 “金鹏信息分布式组件构建平台”
  2. 找到对应的项目,下载源码到本地,新建分支(名字自定义),修改代码。
  3. 安装到本地,项目测试通过,提交分支,并在gitlab上创建合并请求。
  4. 管理员收到合并请求,测试通过,合并到主分支,自动发布到公司内部私服生效。

如图所示:code-contribute

2.2. 贡献新类库

请联系平台公司架构组进行评审,测试,通过后升级发布。

3. 库修改注意事项

  1. 修改注意兼容原版本,不可因修改造成原项目编译或运行异常。
  2. 修改代码注意代码编码规范。
  3. 修改需要在文档中说明的,请在本项目README.md文档中使用markdown规范编写文档,一并提交。

4. 文档书写规范

  1. 文档内部标题从一级标题开始,标题接口自动生成目录,请勿随意使用标题。标题不需要携带序号,gitbook 插件自动维护。
  2. 文档书写建议顺序:

    1. 文档名称:不用标题,使用标签 <center>标题</center>,避免把文档名称生成目录
    2. 文档顶部标记语言和平台 ![](https://img.shields.io/badge/language-Java-red.svg) ![](https://img.shields.io/badge/platform-Android-blue.svg)
    3. 简介: 描述该类库的作用
    4. 基础环境: 介绍用的的底层库的最低版本号,比如: Java1.8+ vue2.0+
    5. 如何使用
    6. 配置(*)
    7. 实现细节(*)
  3. 代码高亮,使用代码库标记加语言,例如: ```java ```

版权归河南金鹏信息技术股份有限公司所有,仅用于技术交流,禁止用于商业目的 all right reserved,powered by Gitbook该文件修订时间: 2020-02-28 09:28:53

results matching ""

    No results matching ""