提交信息&PR 规范 一条好的 commit message 有多重要？ 什么是好的 commit message？ 如何写好一条 commit message ？ 规定的格式 良好的习惯 规范的语言 Pull Request 规范 提交信息&PR 规范 本文档描述了应用于 MatrixOrigin 的所有存储库的提交消息...

提交信息&PR 规范 一条好的 commit message 有多重要？ 什么是好的 commit message？ 如何写好一条 commit message ？ 规定的格式 良好的习惯 规范的语言 Pull Request 规范 提交信息&PR 规范 本文档描述了应用于 MatrixOrigin 的所有存储库的提交消息...

内容规范 规范与原则 编写完善易懂的文档 减少认知负担 内容规范 This document outlines what should be included in the official documentation. Below, you will find a couple of principles and recommendations...

代码规范 Go 代码规范 Bash 或脚本规范 API 规范 测试规范 目录和文件规范 日志规范 结构化日志 为 Kubernetes 对象使用 klog.KObj 和 klog.KRef 日志级别 提示和格式化 代码规范 在本节中，你将学到与 KubeVela 项目相关的各种代码的代码惯例。不需要一次性学完全篇，但在编码之前，...

编码规范 注释规范 提交规范

编码规范 注释规范 提交规范

命名规范 特殊Header 命名规范 特殊Header 特殊Header以X-Edge- 开头，比如： X - Edge - Access - Token X - Edge - Health - Check - Key

代码规范 开发规则 通用Golang规范 Loggie的规范 日志 日志级别 监控 单元测试 代码风格 向后兼容 Copyright profile 代码规范 开发规则 通用Golang规范 参考： Effective Go Go Code Review Comments Uber Go Style Guide L...

API 设计规范 1. URI 设计 2. Method 设计 ① 查询操作 - GET ② 创建操作 - POST ③ 修改操作 - PUT ④ 删除操作 -DELETE ⑤ 部分更新操作 -PATCH ⑥ 其他操作 3. 参数设计 4. 其他设计 基础路径 API 设计规范 规范统一的 API 是项目设计的基石。Dolphin...

内容规范 规范与原则 编写完善易懂的文档 减少认知负担 内容规范 本文档致力于帮助大家评估哪些内容应该加入到官方文档中。你可以在下面找到一些关于如何编写简单易懂的内容的原则和建议。 我们想实现两个目标： 与用户共情。 写作时，应该让通过文档来学习变得简单。 编写完善的参考手册 。我们这里的目标不是教授编程的基础知识。我们应该提供了解如何...