服务器 网站打开慢,安顺建设工程造价管理网站,合作制作网站,企业信息管理系统有哪些目录 Git 提交信息格式格式描述Subject#xff08;标题#xff09;Body#xff08;正文#xff09; 规范的标签#xff08;Tag#xff09;示例 CG Git 提交信息格式
格式描述
一般开源项目代码库根目录都会有一个 CONTRIBUTING.md 或者其他类似名字的文档来介绍如何开始… 目录 Git 提交信息格式格式描述Subject标题Body正文 规范的标签Tag示例 CG Git 提交信息格式
格式描述
一般开源项目代码库根目录都会有一个 CONTRIBUTING.md 或者其他类似名字的文档来介绍如何开始贡献像https://github.com/imputnet/cobalt/blob/main/CONTRIBUTING.md。贡献代码时需要注意 commit message 的规范可能每个开源项目的要求不尽相同但大多遵守以下的conventional commits(中文版)格式
type[optional scope]: description[optional body][optional footer(s)]提交信息通常分为三部分主要由 subject 和 body 组成 Subject标题简短、简洁的一行描述通常限制在 50 字符以内。空行在 subject 和 body 之间留一个空行以区分两部分。Body正文提供更详细的描述包括为什么做这个修改、修改的内容、相关的上下文等。建议每行长度限制为 72 个字符。
Subject标题
简短描述不超过 50 个字符描述改动的主题。使用标签用类型标签开头描述改动的操作类型。没有句号标题行不加句号。
Body正文
解释背景和动机详细描述为什么做这个改动有无相关的 bug 或任务描述具体修改内容改动了什么解决了什么问题。每行限制在 72 个字符以内使得正文内容更加易于阅读特别是在终端或者 Git 日志中查看时。
规范的标签Tag
在提交 Git commit message 时使用规范的标签Tag有助于清晰地表达提交内容方便团队协作和版本管理。 feat新增功能feature 示例feat: 新增用户登录功能 fix修复 Bug 示例fix: 修复登录页面崩溃问题 docs仅文档修改Documentation 示例docs: 更新接口文档 style代码格式调整不影响功能不涉及逻辑修改 示例style: 格式化代码调整缩进 refactor重构代码不影响功能和修复 Bug 示例refactor: 优化登录逻辑提升代码可读性 chore其他杂项构建、依赖管理、脚本任务 示例chore: 更新依赖包版本 perf性能优化Performance 示例perf: 优化数据加载速度 test新增或修改测试代码 示例test: 增加登录接口单元测试 ciCI/CD 配置修改持续集成相关 示例ci: 修改GitHub Actions配置 build构建相关的修改如webpack、rollup配置 示例build: 调整打包配置支持多环境打包 revert回滚之前的提交 示例revert: 回滚错误的提交 abc123 wipWork In Progress进行中的工作未完成的任务 示例wip: 页面样式调整中 featfix新增功能并修复相关 Bug 示例feat/fix: 增加注册功能并修复输入校验问题 choredocs更新依赖并调整文档 示例chore/docs: 更新依赖并修复API文档错误
示例
feat: Add **** to utilize **** // 添加新性能的commit message新增了登录功能并且是为了利用用户身份验证 API
feat: Add login functionality to utilize user authentication API修改了某个 bug并且用方法 A 替换了方法 B
fix: Replace method B with method A to resolve issue with data processing完整示例
fix: Replace method A with method B in test to handle IndexedDB async read issue across browsersDue to occasional issues with IndexedDB async reads across different browser versions, method B is used in the test to ensure consistent behavior and data processing.CG
AI Commits自动生成 commit message 工具
