Git-Bug项目开发环境搭建与贡献指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00632/article/details/148418771

Git-Bug项目开发环境搭建与贡献指南

前言

Git-Bug是一个基于Git的分布式缺陷跟踪系统，它将bug跟踪信息直接存储在Git仓库中，实现了与代码版本的无缝集成。本文将详细介绍如何搭建Git-Bug的开发环境，以及参与项目开发的最佳实践。

开发环境搭建

1. 获取源代码

首先需要克隆项目仓库到本地开发环境：

git clone git@github.com:git-bug/git-bug ~/code/git-bug

建议将仓库克隆到~/code/git-bug目录，因为后续文档中的路径都基于此假设。当然，你也可以选择其他目录位置。

2. 安装Nix包管理器

Git-Bug使用Nix来提供一致的开发环境，确保所有开发者使用相同版本的依赖和工具。Nix的安装方式有两种：

多用户模式（推荐）：适合大多数Linux系统
单用户模式：适合没有管理员权限的环境

安装完成后，需要启用两个实验性功能：

# 对于NixOS用户，在系统配置中添加：
nix.settings.experimental-features = [ "nix-command" "flakes" ];

# 对于其他系统，在~/.config/nix/nix.conf或/etc/nix/nix.conf中添加：
experimental-features = nix-command flakes

3. 配置direnv环境管理器

direnv可以自动激活开发环境，极大提升开发体验。安装和配置步骤如下：

使用Nix安装direnv：

nix --extra-experimental-options 'flakes nix-command' profile install nixpkgs\#direnv

创建配置文件并设置：

touch ~/.config/direnv/direnv.toml

# 禁用长时间加载警告
nix run nixpkgs\#dasel -- -r toml -f ~/.config/direnv/direnv.toml \
  put -t int -v 0 ".global.warn_timeout"

# 隐藏环境变量变化输出
nix run nixpkgs\#dasel -- -r toml -f ~/.config/direnv/direnv.toml \
  put -t bool -v true ".global.hide_env_diff"

# 设置自动激活开发环境
nix run nixpkgs\#dasel -- -r toml -f ~/.config/direnv/direnv.toml \
  put -v "~/code/git-bug/.envrc" ".whitelist.exact[]"

根据使用的shell类型，配置相应的集成。

验证开发环境

完成上述步骤后，需要打开一个新的shell会话，然后进入项目目录测试环境是否激活成功：

cd ~/code/git-bug
{ test -n "$IN_NIX_SHELL" && echo "ACTIVE"; } || echo "INACTIVE"

如果输出"ACTIVE"则表示开发环境已成功激活。

常用开发命令

Git-Bug项目提供了一系列便捷的开发命令：

构建命令：
- make build - 构建git-bug并输出到./git-bug
- make build/debug - 构建调试版本
- make install - 构建并安装到$GOPATH/bin
代码格式化：
- nix fmt - 格式化所有代码
- nix fmt <path...> - 格式化指定路径
测试相关：
- nix flake check - 运行所有lint检查和测试
- go test ./commands -update - 更新测试用的golden文件
文档生成：
- go generate - 生成CLI文档和shell补全文件