版本管理信息表 | |
---|---|
文档所属目录 | Contributing/Contributing.md |
现行版本 | 1.0 版,2020年3月 |
现行版本发布日期 | 2020 年 3 月 6 日 |
修订信息 | 1. 第一次发布 Linkis 项目Contributing规范。 |
非常感谢贡献Linkis项目!在参与贡献之前,请仔细阅读以下指引。
我们建议无论是 Bug 反馈还是修复,都先创建一个 Issue 来仔细描述 Bug 的状况,以助于社区可以通过 Issue 记录来找到和回顾问题以及代码。Bug 反馈 Issue 通常需要包含完整描述 Bug 的信息以及可复现的场景,这样社区才能快速定位导致 Bug 的原因并修复它。包含 #bug
标签的打开的 Issue 都是需要被修复的。
在交流过程中,详细描述新功能(或重构)的细节、机制和使用场景,能够促使它更好更快地被实现。如果计划实现一个重大的功能(或重构),请务必通过 Issue 或其他方式与核心开发团队进行沟通,这样大家能以最效率的方式来推进它。包含 #feature
标签的打开的 Issue 都是需要被实现的新功能,包含 #enhancement
标签打开的 Issue 都是需要改进重构的功能。
帮助回答 Issue 中的使用问题是为 Linkis 社区做贡献的一个非常有价值的方式;社区中总会有新用户不断进来,在帮助新用户的同时,也可以展现你的专业知识。
Linkis 用户手册文档在 docs/ 目录下,我们使用了 jekyll 作为 Linkis 的文档服务,可以编辑目录里的 Markdown 文件来对文档做改进。
Linkis 源码可能会产生一些临时分支,但真正有明确意义的只有以下三个分支:
请注意:大特性的dev分支,在命名时除了版本号,还会加上相应的命名说明,如:dev-0.10.0-flink,指0.10.0的flink特性开发分支。
Linkis 前后端代码共用同一个代码库,但在开发上是分离的。在着手开发之前,请先将 Linkis 项目 fork 一份到自己的 Github Repositories 中, 开发时请基于自己 Github Repositories 中的 Linkis 代码库进行开发。
我们建议克隆 dev-* 分支来开发,这样在向 Linkis 主项目提交 PR 时合并冲突的可能性会小很多
git clone https://github.com/yourname/Linkis.git --branch dev-*
用户配置在项目根目录 /config/ 下,项目启动脚本和升级补丁脚本在项目根目录 /bin/ 下, 后端代码及核心配置在 server/ 目录下, 日志在项目根目录 /log/ 下。注意:此处所指项目根目录都指环境变量 LINKIS_HOME 所配置的目录,在使用 IDE 开发过程中也需要配置环境变量,如 Idea 关于环境变量加载的优先级:Run/Debug Configurations
中配置的 Environment variables
—> IDE缓存的系统环境变量。
├── bin # 脚本目录 ├── install.sh # 一键部署脚本 ├── start-all.sh # 一键启动脚本 └── stop-all.sh # 一键停止脚本
├── config # 用户配置目录 ├── config.sh # 一键部署的配置文件 ├── db.sh # 一键部署的数据库配置
代码目录结构
详见 Linkis代码目录结构
日志目录
├── logs # 日志根目录
配置系统环境变量或 IDE 环境变量 LINKIS_HOME,推荐优先使用 IDE 环境变量。
修改 每个微服务resources/ 目录下 application.yml
文件,配置相关属性。
mvn clean package
即可;mvn clean package
。<type>(<scope>): <subject>
原则,详情可以参考阮一峰的 Commit message 和 Change log 编写指南 这篇文章。在贡献代码之前,可以了解一下什么样的提交在 Review 中是受欢迎的。简单来说,如果一项提交能带来尽可能多增益和尽可能少的副作用或风险,那它被合并的几率就越高,Review 的速度也会越快。风险大、价值低的提交是几乎不可能被合并的,并且有可能会被拒绝连 Review 的机会都没有。
如果你对 Linkis 提过颇具价值的 PR 并且被合并,或是连续贡献超过半年,且至少主导过一次版本的发布,你可以通过官方微信群找到Linkis项目的一个 PMC ,如果他愿意提名你为 committer,并愿意为你陈述你的贡献给所有 PMC和Committer,那么接下来会发起一次投票;PMC和其他 Committers 将会一起投票决定是否允许你的加入,如果得到足够票数,你将成为 Linkis 项目的 Committer。
如果你是 Linkis 项目的 Committer,并且你贡献的所有内容得到了其他 Committee 成员的认可,你可以申请成为 Linkis Committee 成员,其他 Committee 成员将会一起投票决定是否允许你的加入,如果全票通过,你将成为 Linkis Committee 成员。