准备工作

非常欢迎您参与到 MatrixOne(以下简称 MO)项目的建设中来!无论你是初识 MatrixOne,还是已经迫切地想参与到开发工作中来,亦或是在阅读文档、使用产品的过程中发现了一些问题,都欢迎你提出意见和建议,与我们共同打造更加强大、稳定的 MatrixOne! 当然,在您向 MatrixOne 项目提出改进之前,我们需要提前说明一些基本规范与流程,以提高整个贡献过程的质量与流畅性,同时也能保障 MO 的稳定性与安全性。 此外,在本章中,我们为尚未熟知 MO 的贡献者们提供一些了解我们的渠道,希望能为你们带来一些便利!

了解 MatrixOne

特点与框架

MatrixOne 简介中您可以了解到 MO 的超融合、云边协同特性以及其所创造的优异表现与独特价值。 此外,在 MatrixOne 框架中您可以详细地了解 MatrixOne 的整体架构,以及存储层、日志层等具体组成情况。 同时,你也可以查阅 MatrixOne 术语表来了解一些复杂的词汇。 在技术层面,SQL 参考指南为您提供了详细的 SQL 语言的参考,其中对语法和示例都有详细解释;同样,自定义函数提供了 MO 中自定义函数的相关解释。

建设情况

目前,MatrixOne v1.1.0 已经发布了,您可以通过版本发布指南来了解最新的发布信息,其中包含了最新的修改与优化。

关于长期的项目规划,请参阅 MatrixOne Roadmap

你可以做些什么?

对 MatrixOne 的贡献可分为以下几类:

  • 报告代码中的 Bug 或文档中的谬误。请在 GitHub 上提出 Issue,并提供问题的详细信息。请记得选取合适的 Issue 模板,并打上标签。
  • 提议新的功能。请在 Feature Request 中描述详情并与社区中的开发人员商议。一旦我们的团队认可了您的计划,您就可以按照工作流程进行具体开发。
  • 实现某个功能或修复既有问题,请按照工作流程完成开发。如果你需要关于某一特定问题的更多背景信息,请就该问题发表评论。

工作目录与文件介绍

我们将为 Githubmatrixorigin/matrixone 的项目目录及其中关键文件进行简单介绍,以期为您的深入了解和开发提供指导性帮助。 matrixone 是 MatrixOne 代码所在的主库,我们将介绍其中的项目目录以及关键文件,以期为您的深入了解和开发提供指导性帮助。

目录内容
/LICENSES相关依赖库的许可
/cmdGo 的可执行文件的 binary entry
optools测试与部署工具
pkgMatrixOne 项目的主要代码库

对于不同的技术模块,/pkg 喜爱的代码结构如下表所示。

目录模块
frontend/SQL 前端
sql/MPP SQL Execution
sql/parserSQL 解析
sql/vectorizeSQL 的向量化执行
catalog/存储元数据的 Catalog
vm/engine存储引擎
vm/engine/aoeAOE 引擎(分析优化引擎)
vm/engine/tpeTPE 引擎(事务处理引擎)
buildin/系统的内置函数

在文档方面,matrixorigin.iomatrixorigin.io.cnartwork 都是在贡献过程中可能使用的库,详情参见文档贡献

目录内容
matrixone/docs/rfcsMatrixOne 项目的设计文档
matrixorigin.io/docs/MatrixOne英文文档网站的具体内容文件(.md 文件)
matrixorigin.io.cn/docs/MatrixOne中文文档网站的具体内容文件(.md 文件)
matrixorigin.io/mkdocs.yml英文文档网站的配置文件
matrixorigin.io.cn/mkdocs.yml中文文档网站的配置文件
artwork/docs文档官网出现的图片和图表

开发环境

MO 主要由 Go 语言编写,因此需要提前安装部署好相关的开发环境,简要的示例流程如下:

  1. 安装版本为 1.20 的 Go,您可以通过 Download GoInstallation instructions 教程来完成整个过程。
  2. 定义环境变量并修改路径,您可以遵循以下示例流程:
  1. export GOPATH=$HOME/go
  2. export PATH=$PATH:$GOPATH/bin

Note

MatrixOne 使用 Go Modules 来管理相关依赖。

若您需要补充 Go 语言的相关知识,可以通过 How to Write Go Code 进行了解。

此外,确保您至少已经安装了单机版本的 MatrixOne,具体过程可参照 Install Standalone MatrixOne

Github & Git

为更好地开发建设 MatrixOne,我们采取了开源运营的方式,通过 Github 为项目维护人员和其他开发者提供了一个协作平台。因此,如果您想参与到 MO 的开发中来,我们强烈建议您采取 Github 的渠道。
若您还未使用过 Github 或缺少相关开发经验,您首先需要熟悉 GitHub 上的相关操作,并学习基本的 git 命令。
如果您没有 Github 帐户,请在 https://github.com 上完成注册。
如果你没有 SSH 密钥,你可以按照 GitHub 上关于 SSH 的教程来生成、添加密钥。
更多详情请参见 Github Docs

此外,我们建议您学习并使用 git 命令来完成 Github 上的各种流程,因为我们提供的相关工作流程大多通过 git 命令完成,这有助于您提高效率。
您可通过 Install git 安装 Git 环境。
并且可以通过以下教程来学习如何使用: