GitHub 学习工具箱

一个用于学习 GitHub 协作开发的多功能命令行工具箱。代码精简（单文件核心），但覆盖了 GitHub 学习的完整流程：代码、测试、CI、文档、分支、PR、Issue、Release 等。

功能一览

子命令	功能	示例
calc	安全计算器（+ - * / 括号）	python main.py calc "1+2*3"
pwd	随机密码生成	python main.py pwd -n 16
stat	统计目录文件类型与大小	python main.py stat
time	显示当前时间	python main.py time
game	猜数字游戏	python main.py game -m 50
fib	斐波那契数列	python main.py fib 10

快速开始

git clone <你的仓库地址>
cd <仓库名>
python main.py calc "2*(3+4)"   # 输出 14
python -m unittest discover -s tests   # 运行测试

通过本项目你能学到的 GitHub 技能

1. 仓库管理

• git init / git clone / git remote
• .gitignore 忽略规则
• LICENSE 开源协议选择

2. 日常工作流

• git add / git commit / git push / git pull
• 提交信息规范（见 CONTRIBUTING.md）
• 查看历史：git log / git diff

3. 分支与协作

• 创建分支：git checkout -b feature/add-xxx
• 合并分支 / 解决冲突
• 发起 Pull Request 并进行 Code Review

4. Issue 跟踪

• 提交 Bug 报告 / 功能建议
• 使用标签（bug / enhancement / help-wanted）
• 关联 Issue 与 PR：在 PR 描述中写 Closes #1

5. 持续集成（CI）

• .github/workflows/ci.yml 会在每次推送时自动运行测试
• 学习状态徽章、自动化测试

6. Release 发布

• 打标签：git tag v1.0.0
• 创建 Release，发布可执行版本

7. 文档与协作规范

• README.md 项目说明
• CONTRIBUTING.md 贡献指南
• 代码注释与测试规范

项目结构

.
├── main.py                 # 核心代码（多功能工具箱）
├── tests/
│   └── test_main.py        # 单元测试（13 个用例）
├── .github/workflows/
│   └── ci.yml              # GitHub Actions 持续集成
├── .gitignore              # 忽略规则
├── LICENSE                 # MIT 协议
├── CONTRIBUTING.md         # 贡献指南
├── requirements.txt        # 依赖（本项目无第三方依赖）
└── README.md               # 你正在看的文件

练习任务（边做边学）

1. Fork & Clone：Fork 本仓库到你的账号，克隆到本地。
2. 新建分支：git checkout -b feature/add-reverse，新增一个字符串反转功能。
3. 提交：git commit -m "feat: 新增字符串反转功能"。
4. 推送并发起 PR：推送分支后在 GitHub 上发起 Pull Request。
5. 触发 CI：观察 Actions 页面，确认测试自动通过。
6. 提 Issue：提出一个功能建议（如"新增单位换算"）。
7. 打 Tag 发布：git tag v1.0.0 && git push --tags，创建 Release。

测试

python -m unittest discover -s tests -v

许可证

MIT License - 详见 LICENSE