MariaDB 编码标准

编码标准通常和 vim 对 emacs 以及其他开发者争论一样激烈。看过电视剧《硅谷》的人都知道“制表符 vs 空格” 的场景,以及人们对此有多么充满热情。虽然我个人有一个偏好(我在这里不分享),但我认为更重要的是大家在一个代码库中坚持使用一个标准。
标准的故事
几个月前,一位新的 MariaDB Server 社区开发者给我发信息,询问在哪里可以找到我们的编码标准文档。经过一番搜索,我意识到我们并没有这样一个文档,而如果我们想吸引新的开发者加入,我们绝对应该有一个。这实际上让 MariaDB Server 的情况稍微复杂一些,因为它吸收了许多外部项目,主要是存储引擎,而这些项目都有自己的编码标准。
因此,我开始着手创建一个位于 MariaDB 代码库中的编码标准文档。总体的想法是描述主要 MariaDB 代码库的意图,供人们遵循。由于它就在代码库中,人们可以通过 pull request 来修改它,就像修改任何代码一样。
目前,该文档只涵盖主要的 MariaDB Server 源代码,但可以想象,每个引擎都可以有一个类似的文档。最终目标是,一旦定义确定下来,这些文档就会变成规范性的,而不是描述性的。我们甚至可以创建一个 CI 测试,以确保提交的代码符合标准。
在哪里可以找到它们?
您可以在 MariaDB Server 11.0 及更高版本的代码库中找到名为“CODING_STANDARDS.md”的 Markdown 文档。此外,当您对 MariaDB Server 11.0 或更高版本提交 pull request 时,系统会要求您确认已遵循这些标准。我们将仔细检查 MariaDB 知识库并更新开发者指南,使其指向此文档。MariaDB Server 源代码中的指南已相应地进行了修改。
特色图片:XKCD 标准,根据知识共享署名-非商业性使用 2.5 许可使用。