1. 提交问题反馈
本我的项目应用 git issue 跟踪反馈问题,在提交问题反馈前,请先进行以下操作:
- 确保您的利用版本曾经是最新,因为您遇到的问题可能在最新版本中曾经修复
- 能够尝试切换到旧版本,测试问题是否仍然存在,这有助于咱们能够疾速定位问题
- 查看我的项目的 issue 列表中是否已存在该问题
2. 问题反馈须要蕴含的信息
为了让我的项目开发者能疾速复现问题,倡议提交的问题反馈中至多蕴含以下信息:
- 应用程序版本,能够是某个 release 版本号,或者对应代码提交的 commit id
- 本地运行环境,譬如 Linux 发行版,Windows 或者 MacOS 版本,64 位还是 32 位零碎,越具体越好
- 应用的 Golang 版本号,如 Golang 1.16,Golang 1.15
- 开发者如何能复现 bug?能够包含一系列的操作,或者是一段代码,也能够是任何相干的上下文信息;当然,也是越具体越好
3. 提交合并申请
在开始编码前倡议先浏览我的项目的疾速入门文档以及开发文档,如
- 应用 Docker 运行智汀家庭云
- 开发环境搭建
- 架构概述
须要留神的是智汀家庭云基于 Apache License, Version 2.0 开源协定公布,请确保您的代码与该协定兼容。
- 编码标准
编码标准次要参考 Uber Go Style Guide(Uber Go 语言编码标准) - 开发流程
我的项目次要蕴含以下分支: - master 预公布的分支,咱们会基于 master 分支来打新版本的标签,如 1.1.0,1.2.0
- dev 主开发分支,当新性能开发、测试实现后会合并到 master 分支上,倡议基于此分支提交合并申请
- production 分支针对最新版本的修复,合并后会打 1.1.1,1.1.2 等标签进行公布
开发流程 - Fork 我的项目源码到您的帐号,而后从 master, dev 或者 production 分支进行开发
- 编写代码,并且同步更新文档
- 确保您的代码合乎咱们的编码标准以及开源协定
- 测试您的代码
- 提交合并申请到 dev 或者 production 分支
4. 开发第三方插件
您也能够通过开发插件的模式参加到我的项目中,欠缺智汀家庭云对第三方硬件的反对,让更多用户受惠。
能够先浏览开发您的第一个插件来疾速入门插件开发,而后浏览插件零碎设计技术概要, 设施插件开发 等文档进一步理解插件的实现机制。
5. 开源协定
Apache License, Version 2.0