git-recall 开发者指南：如何贡献代码和扩展功能

【免费下载链接】git-recall An interactive way to peruse your git history from the terminal 项目地址: https://gitcode.com/gh_mirrors/gi/git-recall

git-recall 是一款简单便捷的 Git 工具，能帮助开发者从终端轻松回顾自己的提交历史。本指南将详细介绍如何为这个开源项目贡献代码和扩展功能，让你快速成为社区贡献者。

准备贡献环境

1. 克隆项目仓库

首先，你需要将项目代码克隆到本地环境：

git clone https://gitcode.com/gh_mirrors/gi/git-recall
cd git-recall

2. 了解项目结构

项目主要包含以下核心文件：

• git-recall：主程序脚本，采用 Bash 编写
• package.json：NPM 包配置文件
• Makefile：安装脚本
• README.md：项目说明文档

开发规范与流程

代码风格要求

• Bash 脚本需遵循 ShellCheck 规范
• 变量命名采用全大写蛇形命名法（如 AUTHOR、FETCH）
• 函数定义使用 function name() { ... } 格式
• 代码注释需清晰说明功能逻辑，特别是复杂算法部分

提交规范

• 提交信息需简洁明了，格式为：[类型]: 描述内容
• 类型包括：feat（新功能）、fix（修复）、docs（文档）、refactor（重构）等
• 每次提交应专注于单一功能或修复，避免混合多个无关更改

功能扩展指南

添加新命令行选项

如需为 git-recall 添加新的命令行选项，可按照以下步骤进行：

1. 在 git-recall 脚本的 usage() 函数中添加选项说明（参考第 5-18 行）
2. 在选项解析部分（第 73-107 行）添加参数处理逻辑
3. 在 GIT_LOG 变量（第 141-143 行）中集成新选项对应的 Git 命令参数
4. 添加必要的错误处理和边界检查

示例：添加提交过滤功能

假设我们要添加 -k 选项用于按关键词过滤提交信息：

# 在 usage() 函数中添加
#    -k, --keyword           Filter commits by keyword in message

# 在选项解析部分添加
#    -k | --keyword )
#        KEYWORD="$2"
#        shift
#        ;;

# 在 GIT_LOG 中添加
#        --grep "$KEYWORD"

测试与验证

本地测试方法

1. 确保修改后的脚本具有可执行权限：

   chmod +x git-recall
   

2. 直接运行脚本进行功能测试：

   ./git-recall -d 7 -a "all"
   

3. 使用不同参数组合测试边界情况，如：
   • 无提交记录时的处理
   • 长提交信息的显示
   • 特殊字符的处理

兼容性测试

项目要求兼容：

• Linux 或 OSX 系统
• Bash 4.3 及以上版本
• Git、less、sed 工具

提交贡献

拉取请求流程

1. 从 main 分支创建特性分支：

   git checkout -b feature/your-feature-name
   

2. 完成开发后提交更改：

   git add .
   git commit -m "feat: add keyword filter option"
   

3. 推送到远程仓库并创建拉取请求

贡献检查清单

•  代码符合项目风格规范
•  添加了必要的测试用例
•  更新了相关文档（如 README.md）
•  所有功能在本地测试通过
•  提交信息清晰规范

社区参与

问题反馈

如发现 bug 或有功能建议，可通过项目的 issue 系统提交反馈。报告问题时请包含：

• 环境信息（系统、Bash 版本等）
• 详细的复现步骤
• 预期行为与实际结果对比

代码审查

积极参与社区代码审查，为其他贡献者提供建设性反馈。审查时重点关注：

• 代码逻辑正确性
• 性能影响
• 兼容性问题
• 安全隐患

项目资源

• 许可证：LICENSE
• 安装脚本：Makefile
• NPM 配置：package.json

通过本指南，你已经了解了为 git-recall 项目贡献代码的完整流程。无论是修复小 bug 还是添加新功能，每一份贡献都能帮助这个工具变得更好。期待你的参与，让 git-recall 成为更强大的 Git 历史查看工具！

【免费下载链接】git-recall An interactive way to peruse your git history from the terminal 项目地址: https://gitcode.com/gh_mirrors/gi/git-recall