[r2cn] 编写 git-internal 项目的架构设计文档、例子和补全测试用例

[genedna]

[任务] 编写 git-internal 项目的架构设计文档、例子、注释和测试用例

[任务分值] 80 分

[背景描述] 当前 git-internal 项目的功能已经具备基本功能，但是缺乏文档、例子和注释等，需要提供完整的内容，为使用这个仓库的其他项目提供完整的支持。

[需求描述]

1. 编写架构说明文档和 Git 对象的文档；
2. 编写参照 Libra 和 Mega 项目，编写 Example ；
3. 为项目的函数补齐注释；
4. 为项目的测试用例补齐注释，分析测试用例的覆盖度；

[代码标准]

1. 所有 PR 提交必须签署 Signed-off-by 和 使用 GPG 签名，即提交代码时（使用 git commit 命令时）至少使用 -s -S 两个参数，参考 Contributing Guide；
2. 所有 PR 提交必须通过 GitHub Actions 自动化测试，提交 PR 后请关注 GitHub Actions 结果；
3. 代码注释均需要使用英文;

[PR 提交地址] 提交到 git-internal 仓库的 main 分支 examples 和 docs 目录；

[开发指导]

1. 认领任务参考 r2cn 开源实习计划 - 任务认领与确认;

[导师及邮箱] 请申请此题目的同学使用邮件联系导师，或加入到 R2CN Discord 后在 #p-mega 频道和导师交流。

1. Quanyi Ma genedna@qq.com
2. Tianxing Ye yetianxing2014@gmail.com

[备注]

1. 认领实习任务的同学，必须完成测试任务和注册流程，请参考： r2cn 开源实习计划 - 测试任务 和 r2cn 开源实习计划 - 学生注册与审核

[r2cn-bot]

任务创建成功。

[jackieismpc]

/request-assign

[r2cn-bot]

认领成功：等待导师审核，请及时联系导师进行审核。

[genedna]

/intern-approve

[r2cn-bot]

认领审核成功：已将该任务分配给学生。

[jackieismpc]

/request-complete