gitmob

命令行应用程序，帮助您在结对/移动编程期间自动向 git 提交添加 Co-authored-by 尾部。

您可以通过向提交信息添加一个或多个 Co-authored-by 尾部来将 git 提交归因于多个作者。共同提交在 GitHub 上可见。更多信息请参见此处。

此命令行应用程序将帮助您自动添加它们，并帮助您存储和管理结对/移动编程会话的共同作者。

功能

• 跨平台
• 通过 CLI 管理共同作者
• 多选菜单，选择移动编程的共同作者
• 自动将 Co-authored-by 尾部附加到提交
• 无需任何 git 别名

安装

先决条件

• Git v2.32 或更高版本

使用二进制包

• 从 最新的 GitHub 发布版 下载并解压适合您操作系统的相应二进制文件

• 确保二进制文件在您的 PATH 变量中，例如，您可以在 Windows 上将其放在 C:\Windows，在 Linux 和 macOS 上放在 /usr/local/bin

• 确保二进制文件具有可执行权限（Linux 和 macOS）

  $ chmod +x ./git-mob
  

使用 Cargo

• 安装 Rust
• 如果您使用的是 Windows，您还需要安装某些 C++ 编译工具

$ cargo install git-mob-tool

设置和配置

• 设置一个全局的 prepare-commit-msg githook，它将 Co-authored-by 尾部附加到提交信息。

  $ git mob setup --global
  

  如果存储库覆盖了 core.hooksPath Git 配置变量（例如使用 husky 时），则需要为每个这样的存储库额外运行 git mob setup --local。这将设置一个本地（存储库特定）的 prepare-commit-msg Git 钩子，它将调用全局钩子。

  如果您希望手动设置或在使用自动化设置过程中遇到任何问题，可以按照这里概述的步骤进行。

• 使用密钥存储团队成员的详细信息

  $ git mob coauthor --add lm "Leo Messi" [email protected]
  $ git mob coauthor --add em "Emi Martinez" [email protected]
  $ git mob coauthor --add sa "Sergio Aguero" [email protected]
  

用法

• 要与某些团队成员进行协同工作

  $ git mob --with
  ? Select active co-author(s):
  > [ ] Leo Messi <[email protected]>
    [ ] Emi Martinez <[email protected]>
    [ ] Sergio Aguero <[email protected]>
  [↑↓ to move, space to select one, → to all, ← to none, type to filter ]
  

  或者，如果您记得合著者密钥，可以通过运行以下命令绕过多选菜单

  $ git mob --with lm em
  

  这将启动一个全局协同工作会话。之后的任何 Git 提交都将添加以下所示的 Co-authored-by 尾部到提交信息中

  This is an example commit message
  
  Co-authored-by: Leo Messi <[email protected]>
  Co-authored-by: Emi Martinez <[email protected]>
  

• 要清除协同工作会话

  $ git mob --clear
  

• 要查看当前协同工作会话中的合著者

  $ git mob --list
  

• 要打印帮助信息

  $ git mob help
  $ git mob help coauthor
  

故障排除

• 当使用 git mob --help 时，可能会发生错误，因为 Git 正在寻找子命令的 man 页面。为了避免此错误，请使用以下替代方案之一
  • gitmob help
  • git-mob--help