企业官网建设流程全解析

Stable-Worldmodel贡献者指南：代码提交与Pull Request完整流程

【免费下载链接】stable-worldmodelA platform for reproducible world model research and evaluation项目地址: https://gitcode.com/GitHub_Trending/st/stable-worldmodel

Stable-Worldmodel作为可复现的世界模型研究与评估平台，欢迎所有开发者参与贡献。本指南将帮助你快速掌握从代码提交到PR合并的全流程，让你的贡献顺利融入项目。

1. 准备开发环境

1.1 克隆项目仓库

首先通过Git获取项目源码：

git clone https://gitcode.com/GitHub_Trending/st/stable-worldmodel cd stable-worldmodel

1.2 安装开发依赖

项目使用Ruff进行代码格式化和 linting，通过以下命令安装完整开发环境：

pip install -e .[all,dev]

开发依赖配置可见 pyproject.toml 文件的[dependency-groups]部分，包含了pre-commit、pytest和ruff等工具。

2. 代码开发规范

2.1 代码风格要求

项目采用Ruff作为主要的代码检查工具，配置如下：

• 行长度限制：79个字符
• 缩进：4个空格
• 引号：单引号优先
• 具体规则见 pyproject.toml 的[tool.ruff]部分

提交前建议运行格式化命令：

ruff format

2.2 测试要求

所有代码贡献需包含相应测试：

• 单元测试放在tests/目录下
• 环境测试可参考 tests/envs/ 示例
• 运行测试命令：pytest tests/

3. 提交代码流程

3.1 创建分支

从main分支创建功能分支：

git checkout main git pull origin main git checkout -b feature/your-feature-name

3.2 提交规范

提交信息需遵循以下格式：

[类型]: 简短描述（不超过50字符） 详细描述（可选，说明实现细节和解决的问题） 相关Issue: #123

类型包括：feat(新功能)、fix(修复)、docs(文档)、refactor(重构)等。

3.3 本地验证

提交前务必进行本地验证：

# 代码格式化 ruff format # 代码检查 ruff check # 运行测试 pytest tests/

4. 创建Pull Request

4.1 推送分支

将本地分支推送到远程仓库：

git push origin feature/your-feature-name

4.2 PR内容要求

PR描述应包含：

• 功能/修复的详细说明
• 实现思路
• 测试方法
• 相关文档更新（如需要）

4.3 代码审查

PR创建后，项目维护者会进行代码审查，可能会提出修改意见。请及时响应并进行调整。

5. 持续集成检查

PR提交后将自动触发CI流程，包括：

• 代码风格检查（Ruff）
• 单元测试（Pytest）
• 文档构建

图：CI流程中GPU资源使用监控示例

6. 贡献被接受后的后续步骤

一旦PR被合并：

1. 你的代码将成为项目的一部分
2. 可在项目文档的贡献者列表中添加你的名字
3. 关注后续发布版本，查看你的功能何时正式发布

7. 其他资源

• 项目文档：docs/
• API参考：docs/api/
• 环境测试示例：tests/envs/test_pusht_policy.py

希望本指南能帮助你顺利为Stable-Worldmodel项目贡献代码！如有任何疑问，欢迎在项目Issue中提问。

【免费下载链接】stable-worldmodelA platform for reproducible world model research and evaluation项目地址: https://gitcode.com/GitHub_Trending/st/stable-worldmodel