团队

一个用于管理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 fame

pip install git-fame

提交者安装

cargo install cargo-watch zuu teams

提交信息格式

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

[Description with more details]

[Why changes details]

[Footer]

提交类型

使用Cosmic类型进行提交消息管理

它们是什么？

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

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

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

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

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

• 1. 团队采用

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

  2. 实施

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

  3. 持续改进

  • 定期审查：定期审查团队的提交历史，以确保宇宙提交类型的持续使用，并确定任何需要改进或优化的格式。
  • 反馈循环： 鼓励团队成员就所选提交类型的有效性以及改进建议进行开放沟通和反馈。
  • 迭代优化： 不要害怕实验和调整提交类型以更好地满足不断变化的项目需求。关键在于找到一个适合您团队的系统，并增强您的Git工作流程。

  4. 持续改进

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

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

  宇宙提交的整体目标是使Git提交信息对开发者来说更加信息丰富、引人入胜和愉悦，从而最终促进更好的协作、可维护性和对项目历史的理解。

为什么自动化提交信息？

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

• 确保一致性： 所有提交信息都遵守约定，使Git历史更加有序且易于分析。
• 节省时间： 贡献者无需手动格式化信息，从而提高工作效率。
• 减少错误： 工具引导贡献者创建有效的信息，防止拼写错误或不一致。

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

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

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

宇宙提交类型提供了一种独特且引人入胜的方式来分类和描述Git提交历史中的更改。以下是它们有益的原因

增强清晰度和沟通

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

改进组织和可维护性

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

增加参与感和乐趣

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

自动化和工具

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