Commiter

一个用于管理 Rust 团队的程序。

• 它的目的是工具，用于
  • 提交信息
  • 生成变更日志
  • 创建并完成特性
  • 管理分支
  • 管理标签
  • 显示标签
  • 查看 Git 日志
  • 添加并发送修改
  • 使用 stash 创建分支
  • 查看带有最新提交的分支
  • 删除 cargo 依赖项
  • 为提交信息使用 hunspell 字典
  • 在本地安装 cargo 项目
  • 无需提交钩子
  • 运行测试
  • 运行 clippy 检查器
  • 自动运行 cargo fmt 格式化代码源

它要求 hunspell 命令可用且已安装 en_US 字典。

安装依赖

Fedora

sudo dnf install hunspell hunspell-en_US rustup git

Debian

sudo apt install hunspell hunspell-en_US rustup git python-pip

Silverblue

rpm-ostree install hunspell hunspell-en_US rustup git python-pip

ArchLinux

sudo pacman -S hunspell hunspell-en_US rustup git python-pip

Cargo 初始化

rustup default stable

Git 命令

pip install git-fame

Commiter 安装

cargo install cargo-watch zuu teams

提交信息格式

<type>(<scope>): <short summary>

[Description with more details]

[Why changes details]

[Footer]

提交类型

使用Cosmic Types进行提交信息管理

它们是什么？

• 提交信息管理：编写清晰、一致、信息丰富的提交信息，以改善项目协作和理解。
• Cosmic 提交类型：一种特定的提交信息约定，使用来自天文学和太空探索的术语和概念来分类更改。这使得消息更具吸引力且更容易理解。

为什么使用提交信息管理？

• 增强协作：清晰的消息有助于团队成员理解每个更改的上下文和目的。

• 改进历史跟踪：良好的提交日志结构使跟踪开发过程、查找特定更改和生成有意义的变更日志更加容易。

• 简化审查：简洁且描述性的消息简化了代码审查，并有助于更快地识别潜在问题。

• 1. 团队采用

  • 讨论并达成一致：与您的团队讨论使用Cosmic提交类型。解释其好处，分享本指南，并收集反馈。
  • 自定义：共同决定要使用的特定提交类型。您可以从这里提供的综合列表开始，并根据项目的具体需求和偏好进行调整。
  • 文档：创建一个明确且简洁的参考文档，概述所选提交类型、其含义和示例。确保该文档对所有团队成员都易于访问。

  2. 实施

  • 手动方法：您可以通过简单地遵循提交信息中的 <type>(<范围>): <简短摘要> 格式来手动使用Cosmic提交类型。
  • Git 提交模板：创建一个Git提交模板文件（例如 .gitmessage），以在您的编辑器中自动填充提交信息格式。这可以帮助强制执行一致性并提醒贡献者可用的提交类型。
  • Git 钩：利用Git钩子，如 prepare-commit-msg 钩子，验证您的提交信息并确保它们符合所选格式。
  • 自动化工具：考虑利用如 commitizen 或 cz-cli 等工具，这些工具提供了根据所选约定创建提交信息的交互式提示。这些工具可以简化流程并确保团队内部的一致性。

  3. 持续改进

  • 定期审查：定期审查团队的提交历史，以确保一致地使用Cosmic提交类型，并识别任何可能需要改进格式的领域。
  • 反馈循环：鼓励团队成员就所选提交类型的有效性以及任何改进建议进行开放沟通和反馈。
  • 迭代改进：不要害怕实验和调整提交类型以更好地适应您不断发展的项目需求。关键是找到一个适合您团队且能增强您的Git工作流程的系统。

  4. 持续改进

  • 鼓励创新：在保持一致性的同时，允许团队成员在既定框架内为提交信息增添自己的风格和个性。
  • 庆祝里程碑：使用像“登月”这样的特殊事件提交类型来庆祝重大成就，并保持团队的积极性。
  • 与其他工具集成：探索与您的任务跟踪系统、CI/CD管道或文档工具的集成选项，以自动化流程并最大化使用宇宙提交类型的优势。

  通过接受这份全面的指南并将宇宙提交类型融入您的Git工作流程，您可以将提交历史转换为充满活力、信息丰富、令人愉悦的项目历程的反映。

  宇宙提交的总体目标是使Git提交信息更具信息性、吸引力和乐趣，从而最终促进更好的协作、可维护性和对项目历史的理解。

为什么自动化提交信息？

虽然Angular提交信息约定提供了一个清晰和结构化的格式，但手动执行可能会很繁琐且容易出错。自动生成提交信息工具可以帮助您

• 确保一致性：所有提交信息都遵循约定，使Git历史更加有序且易于分析。
• 节省时间：贡献者不必手动格式化消息，从而提高工作效率。
• 减少错误：该工具指导贡献者创建有效的消息，防止出现错别字或不一致的情况。

为什么特别使用宇宙提交类型？

• 描述性：像“星”（新功能）或“彗星”（错误修复）这样的术语可以立即识别，并一眼看出更改的性质。
• 吸引人：宇宙主题为提交信息增添了有趣和难忘的元素。
• 标准化：为提交信息提供共享的词汇和结构化格式，提高团队之间的连贯性。

为什么是宇宙提交类型？

宇宙提交类型提供了一种独特且吸引人的方式来分类和描述Git提交历史中的更改。以下是它们的好处

增强清晰度和沟通

• 描述性标签：使用“星”表示新功能、“彗星”表示错误修复或“星云”表示重构等术语，可以立即将更改的性质传达给阅读提交日志的任何人。这改善了团队内的沟通和理解。
• 视觉扫描：使用与天体和事件相关的生动图像，可以轻松快速地扫描提交历史并识别特定类型的更改。
• 上下文信息：提交信息中可选的添加作用域提供了有关受影响的代码库部分的进一步上下文（例如，“Star(UI)”表示新的UI功能）。

改进组织和可维护性

• 结构化格式：宇宙提交信息的统一格式（例如，“类型（作用域）：简短摘要”）使提交历史更加有序且易于解析。这有助于生成变更日志或根据特定标准筛选提交等任务。
• 简化历史：一个组织良好的提交历史使跟踪项目的演变、识别模式以及快速定位特定更改的引入变得更加容易。

增加参与度和乐趣

• 创意表达：宇宙主题为通常单调乏味的编写提交信息任务增添了个性和乐趣。它可以使开发过程对团队来说更加愉快和吸引人。
• 共享词汇：使用一组共同的提交类型可以培养团队之间的共同理解和友谊。它也可以作为有趣的话题开始或打破僵局。

自动化和工具

• 变更日志生成：许多工具可以通过解析提交消息自动生成变更日志或发布说明。宇宙提交类型通过提供清晰的架构和一致的词汇，使这个过程更加简单，工具可以轻松理解。
• 问题跟踪集成：如果您在提交消息中引用问题编号，一些工具可以自动将提交链接到相应的议题，简化您的流程并使项目管理系统保持最新。