Especificación de mensaje de confirmación de Git

¡Trabajar juntos para crear y crecer juntos! Este es el día 31 de mi participación en el "Nuevo plan diario de Nuggets · Desafío de actualización de agosto", haga clic para ver los detalles del evento

Visión general

No sé cómo escribes el mensaje de confirmación que proporciona el código en tus respectivos proyectos. Algunos colegas de nuestro proyecto lo escribieron de manera muy simple. Ni siquiera saben qué enviar, si es una nueva función o una corrección de errores. . En esencia, el mensaje de confirmación es para que los miembros del equipo conozcan el contenido de este envío. Por esta razón, hemos formulado una especificación que estipula que cada colega del equipo envíe el código de acuerdo con esta especificación, de modo que el contenido de esta modificación se puede entender a través del mensaje.

1. Formato del mensaje de confirmación

Cada confirmación, mensaje de confirmación incluye tres partes: encabezado, cuerpo y pie de página.

<type>(<scope>): <subject>
// 空一行
<body>
复制代码

Entre ellos, se requieren tipos de encabezado, cuerpo de envío para hazaña y corrección. Independientemente de la sección, ninguna línea debe exceder los 72 caracteres (o 100 caracteres). Esto es para evitar que el ajuste de línea afecte la estética.

1.1 Encabezado

La sección Encabezado tiene una sola línea e incluye tres campos: tipo (obligatorio), ámbito (obligatorio) y asunto (obligatorio).
(1) tipo
type se usa para describir la categoría de compromiso, solo se permiten los siguientes 7 signos.

feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
build:构建过程或辅助工具的变动
复制代码

(2) El alcance
del alcance se usa para describir el alcance del impacto del compromiso, como plantillas de indicadores, reglas en línea y fuera de línea, etc., que varían de un proyecto a otro.
(3) asunto
asunto es una breve descripción del propósito de la confirmación, no más de 50 caracteres.

1. 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
2. 第一个字母小写
3. 结尾不加句号(.)
复制代码

1.2 Cuerpo

La parte del cuerpo es una descripción detallada de esta confirmación, que se puede dividir en varias líneas.

1. 需要简要的列出各种正向或者反向的测试场景,测试通过,填pass。
2. 增加修改人信息
复制代码

2. Ejemplos

2.1 ejemplo de hazaña

feat(规则上下线、构建、生效、仿真生效): 添加规则上下线功能 

1. 规则上下线主流程,引擎正常订阅,fldl生成正常。 pass
2. 规则上下线,传入不存在的规则编号,异常提示。 pass

提交人:xxx
复制代码

2.2 Ejemplo de corrección

fix(模型模块): 模型测试失败

1. 导入mar模型,包含衍生字段。 pass
2. 导入mar模型,不包含衍生字段。 pass

提交人:xxx
复制代码

Recomendación de complemento

IDEA puede instalar complementos para las especificaciones de envío de código.

  1. Instalar el complemento

imagen.png2. Seleccione el complemento para enviar al enviar

imagen.png

imagen.png

Supongo que te gusta

Origin juejin.im/post/7136698563840442375
Recomendado
Clasificación