RomM贡献指南：从代码提交到PR审核的完整流程
项目地址: https://gitcode.com/gh_mirrors/ro/romm RomM是一个基于Web的复古游戏ROM管理器，集成了IGDB数据库，为怀旧游戏爱好者提供了完整的游戏库管理解决方案。如果你想要为这个优秀的开源项目贡献代码，本指南将带你了解从环境搭建到PR审核的完整流程。🚀
开发环境快速搭建
在开始贡献代码之前，你需要先搭建开发环境。RomM提供了两种开发环境搭建方式：
Docker开发环境（推荐）
这是最简单快捷的方式，适合大多数贡献者：
# 克隆仓库
git clone https://gitcode.com/gh_mirrors/ro/romm
cd romm
# 复制环境配置文件
cp env.template .env
# 构建Docker镜像
docker compose build
# 启动服务
docker compose up -d
完成这些步骤后，你就可以在http://localhost:3000访问RomM开发环境了！任何代码更改都会自动热重载。
手动环境搭建
如果你更喜欢手动控制开发环境：
# 安装系统依赖
sudo apt install libmariadb3 libmariadb-dev libpq-dev
# 安装Python依赖
uv venv
source .venv/bin/activate
uv sync --all-extras --dev
# 启动后端服务
cd backend
uv run python3 main.py
代码贡献完整流程
1. Fork并克隆仓库
首先，你需要Fork主仓库到自己的账户：
git clone https://gitcode.com/你的用户名/romm.git
cd romm
git checkout master
2. 创建功能分支
永远不要在master分支上直接开发：
git checkout -b feature-or-fix-name
3. 安装代码检查工具
RomM使用Trunk进行代码检查和格式化：
# 安装Trunk CLI
curl https://get.trunk.io -fsSL | bash
# 手动运行检查
trunk fmt
trunk check
重要提示： 如果不安装并运行代码检查工具，CI检查会失败，PR将无法合并。
4. AI辅助开发声明
如果你使用任何AI工具协助开发，必须在PR中明确声明：
此PR主要由AI工具协助完成。
或者更详细的声明：
我使用ChatGPT来理解代码库，但解决方案完全由我自己手动编写。
测试和代码质量保证
测试环境配置
在提交代码前，确保测试环境正确配置：
# 创建测试数据库
docker exec -i romm-db-dev mariadb -uroot -p密码 < backend/romm_test/setup.sql
运行测试
cd backend
# 运行所有测试
uv run pytest -vv
# 运行特定测试
uv run pytest tests/endpoints/test_rom.py
Pull Request提交规范
PR标题和描述要求
- 标题： 清晰描述功能或修复内容
- 描述： 详细说明更改内容、解决的问题和测试结果
代码风格指南
遵循项目中已有的代码风格。如果你使用VSCode，建议安装这些扩展：
- Prettier - 代码格式化
- Python - Python语言支持
- Pylance - Python语言服务器
- Ruff - Python代码检查
- Vue - Official - Vue.js官方支持
社区行为准则
RomM项目遵循Contributor Covenant行为准则，所有贡献者都应：
- 对其他社区成员表现出同理心和善意
- 尊重不同的意见、观点和经验
- 优雅地接受建设性反馈
- 对错误负责并向受影响者道歉
文档和翻译贡献
文档贡献
如果你想为项目文档做贡献，请向文档仓库提交PR。
添加翻译
要为项目添加新语言翻译：
- 在
frontend/src/locales目录下创建新文件夹 - 参照现有语言文件模板创建翻译文件
- 提交PR将新语言文件添加到项目中
PR审核流程详解
审核标准
- 代码符合项目编码标准
- 更改已通过本地测试
- 必要文档已更新
- 新功能包含相应测试
常见问题解答
Q: 我需要实现大型功能怎么办？ A: 建议先创建issue并加入Discord与维护者讨论你的想法。
Q: 遇到bug如何报告？ A: 在GitHub上创建issue，提供尽可能详细的信息，包括重现步骤。
Q: 贡献代码的许可证要求？ A: 通过贡献代码，你同意你的贡献将按照项目的LICENSE文件进行许可。
总结
通过本指南，你已经了解了为RomM项目贡献代码的完整流程。从环境搭建、代码开发到PR提交，每个步骤都有明确的规范和要求。记住，开源贡献不仅是技术活动，更是社区协作的过程。🤝
开始你的第一个RomM贡献之旅吧！你的每一份贡献都将让这个复古游戏管理器变得更好。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
