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

📅 2026/7/19 15:36:41
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.ktQQ音乐用户界面组件app/src/main/kotlin/cn/lyric/getter/ui 目录包含活动、碎片和视图模型如 MainActivity.kt配置管理Config.kt 负责应用配置AppRules.kt 处理应用规则定义1.2 搭建开发环境克隆项目仓库git clone https://gitcode.com/gh_mirrors/ly/Lyric-Getter使用Android Studio打开项目等待Gradle同步完成确保本地编译通过可运行./gradlew assembleDebug命令验证二、提交代码贡献的完整流程2.1 创建分支从main分支创建功能分支命名格式建议为feature/功能名称或fix/问题描述git checkout -b feature/add-new-music-platform2.2 代码开发规范遵循Kotlin编码规范保持与现有代码风格一致添加平台支持如需新增音乐平台支持可参考 BaseHook.kt 创建新的Hook类更新应用规则修改 app/src/main/assets/app_rules.json 时需同步更新规则说明文档2.3 提交与拉取请求提交代码时使用清晰的 commit 信息git commit -m feat: add support for XXX music platform推送到远程分支git push origin feature/add-new-music-platform在项目仓库页面创建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创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考