BBP-0000.md

Blueking Best Practice - BBP

标号释义

标号形如

BBP-0001

• 其中 BBP- 作为前缀，和其他任何标号系统区分
• 001 代表具体 最佳实践序号，作为某一个最佳实践的唯一标识。

同时为了保证标号有一定的记忆度和扩展性，序号部分我们又分为两个部分：

00                  001
领域序号             领域内序号

什么是领域？这里的领域可以理解为一种技术标签，它代表了某一类技术领域，例如 Python/Golang 这样的语言层面，也可以是 Redis/MySQL 这类的常用的存储组件层面。领域序号默认预留了两位数字，最多支持 99 种领域划分（从1开始，0作为保留序号）。为了保证前期整体标号的短小，领域序号可以简略掉前面多余的 "0"，例如 01 可缩减为 1。

目前已规划的领域：

序号	领域
Python	01
Django	02
Golang	03
MySQL	04
Redis	05

领域内序号比较好理解，就是某一个领域中的最佳实践，默认按照合入的时间依次累加。默认预留了三位数字，支持 999 种最佳实践（从1开始 0 作为保留序号）。

以下列举一些可能的标号，并作相关解释，以便更好理解。

序号	含义
BBP-1001	第一种领域的第一个最佳实践
BBP-1099	第一种领域的第99个最佳实践
BBP-9876	第9种领域的第876个最佳实践
BBP-12123	第12种领域的第123最佳实践

BBP-0000 有关最佳实践的最佳实践

BBP-0000 是一个特殊的最佳实践，用来阐述该最佳实践的用法和维护办法。

如何使用标号？

标号的意义在于给已经形成沉淀的最佳实践用于追溯的索引，一个便于记忆与传播的短名字。常见的场景如下：

• MR/PR 讨论时，可以直接引用标号
• 在代码注释中阐述采用当前方案的原因

标号确立后如何更新？

当某一个实践的标号确定后，不建议对其中内容做大幅度的更新，除非含有事实性错误。

过期

对于一些实践内容因为某些技术版本的更新而发生过期时，应当将当前实践特殊标记为“过期”，在醒目的位置展示过期原因，如有必要可以添加一条新的实践用于替代当前实践的作用，标号累加，而不是删除当前标号。