如何为 MyComic 项目提交代码贡献
贡献流程
MyComic 的贡献流程遵循 GitHub/Gitee 通用的开源贡献模式:
第一步:Fork 仓库
在 Gitee 上打开陆启创的 MyComic 仓库,点击右上角"Fork"按钮将仓库复制到自己账号下。
第二步:克隆与分支
在本地克隆 fork 后的仓库,然后创建一个功能分支:
git clone https://gitee.com/<你的用户名>/MyComic.git
cd MyComic
git checkout -b Feat_NewSource
分支命名约定:功能类改动用 Feat_xxx,修复类用 Fix_xxx,与源码中 issue 模板一致。
第三步:开发与测试
在功能分支上完成你的改动。修改完成后:
- 在 Android Studio 中编译构建,确保项目能正常编译通过
- 运行对应的单元测试(见 06-数据源扩展/06-数据源测试),验证核心逻辑正确性
- 在真机上启动应用,功能能正常运行
第四步:提交与推送
git add .
git commit -m "Feat: 新增 xxx 漫画源"
git push origin Feat_NewSource
第五步:Pull Request
回到 Gitee 自己的 fork 仓库,会看到推送分支的提示。点击"Pull Request"按钮,填写 PR 描述后提交到主仓库。
PR 中建议说明:改动内容、测试方式、关联的 issue(如果有)。
贡献类型
社区贡献的类型非常多样:
| 类型 | 难度 | 价值 |
|---|---|---|
| 新增漫画/小说/番剧源 | 中 | 补充资源池,对普通用户直接有用 |
| 修复失效源 | 低~中 | 保持现有源的可用性 |
| 修复已知 Bug | 中 | 提升应用稳定性 |
| 优化 UI 或交互 | 高 | 提升整体体验 |
| 更新文档 | 低 | 降低新贡献者入门门槛 |
本地调试环境
开发前需要配置:
- Android Studio(最新稳定版)
- Android SDK(项目的
build.gradle中有要求的 target SDK 版本) - Gradle wrapper(随仓库一起下载,无需手动安装)
导入项目后等待 Gradle sync 完成即可开始调试。