Lyric-Getter社区贡献指南：如何提交代码和功能建议

Lyric-Getter社区贡献指南：如何提交代码和功能建议

【免费下载链接】Lyric-GetterLyric Getter | 酒域-歌词获取项目地址: https://gitcode.com/gh_mirrors/ly/Lyric-Getter

欢迎加入Lyric-Getter开源社区！本指南将帮助你轻松参与项目贡献，无论是提交代码改进还是分享功能建议，都能让这款歌词获取工具变得更加强大。

一、贡献前的准备工作

1.1 了解项目结构

在开始贡献前，建议先熟悉项目的核心模块：

• 歌词获取核心逻辑：app/src/main/kotlin/cn/lyric/getter/hook 目录下包含各音乐平台的歌词获取实现，如 Netease.kt（网易云音乐）和 QQMusic.kt（QQ音乐）
• 用户界面组件：app/src/main/kotlin/cn/lyric/getter/ui 目录包含活动、碎片和视图模型，如 MainActivity.kt
• 配置管理：Config.kt 负责应用配置，AppRules.kt 处理应用规则定义

1.2 搭建开发环境

1. 克隆项目仓库：

   git clone https://gitcode.com/gh_mirrors/ly/Lyric-Getter

2. 使用Android Studio打开项目，等待Gradle同步完成
3. 确保本地编译通过：可运行./gradlew assembleDebug命令验证

二、提交代码贡献的完整流程

2.1 创建分支

从main分支创建功能分支，命名格式建议为feature/功能名称或fix/问题描述：

git checkout -b feature/add-new-music-platform

2.2 代码开发规范

• 遵循Kotlin编码规范：保持与现有代码风格一致
• 添加平台支持：如需新增音乐平台支持，可参考 BaseHook.kt 创建新的Hook类
• 更新应用规则：修改 app/src/main/assets/app_rules.json 时需同步更新规则说明文档

2.3 提交与拉取请求

1. 提交代码时使用清晰的 commit 信息：

   git commit -m "feat: add support for XXX music platform"

2. 推送到远程分支：

   git push origin feature/add-new-music-platform

3. 在项目仓库页面创建Pull Request，描述功能实现细节和测试情况

三、功能建议的提交方式

3.1 提交有效的功能建议

通过项目的Issue系统提交建议时，请包含：

• 功能场景描述：如"希望支持XX音乐的桌面歌词显示"
• 实现思路（可选）：如"可参考 MediaSessionObserve.kt 的媒体监听逻辑"
• 应用场景截图（如有）

3.2 参与社区讨论

关注 app/src/main/assets/app_rules_tips.txt 中的规则更新，或在相关Issue下分享你的使用经验和改进想法。

四、贡献者常见问题

4.1 代码审核不通过怎么办？

• 查看审核意见，针对性修改代码
• 涉及核心逻辑的修改建议先在Issue中讨论方案
• 确保所有测试用例通过：可参考 TestActivity.kt 添加测试场景

4.2 如何更新本地代码？

定期同步主分支更新：

git checkout main git pull git checkout your-branch git merge main

五、社区贡献激励

• 所有贡献者将被列入项目致谢名单
• 活跃贡献者可申请成为项目维护者，参与核心决策
• 优质功能贡献将在版本更新日志中特别标注

加入Lyric-Getter社区，一起打造更完善的歌词获取工具！无论是代码提交还是功能建议，每一份贡献都让项目更加精彩 ✨。

【免费下载链接】Lyric-GetterLyric Getter | 酒域-歌词获取项目地址: https://gitcode.com/gh_mirrors/ly/Lyric-Getter