Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
155 lines (112 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

155 lines (112 loc) · 2.83 KB

贡献指南

感谢您对本项目的关注！我们欢迎各种形式的贡献。

如何贡献

报告 Bug

如果您发现了 Bug，请：

  1. 检查 Issues 是否已有相同问题
  2. 如果没有，创建新的 Issue，包含：
    • 清晰的标题
    • 详细的问题描述
    • 复现步骤
    • 期望行为
    • 实际行为
    • 环境信息（Python 版本、操作系统等）
    • 相关代码片段或截图

提出新功能

如果您有好的想法：

  1. 先创建 Issue 讨论这个功能
  2. 说明：
    • 功能描述
    • 使用场景
    • 为什么需要这个功能
    • 可能的实现方式

提交代码

  1. Fork 本仓库

  2. 克隆到本地

    git clone https://github.com/YOUR_USERNAME/baseRL2.git
cd baseRL2

  3. 创建新分支

    git checkout -b feature/your-feature-name

  4. 进行修改

    • 遵循现有代码风格
    • 添加必要的注释
    • 确保代码可以运行

  5. 测试您的更改

    python demo.py  # 确保示例代码能运行

  6. 提交更改

    git add .
git commit -m "Add: 简洁描述您的更改"

  7. 推送到 GitHub

    git push origin feature/your-feature-name

  8. 创建 Pull Request

    • 提供清晰的标题和描述
    • 引用相关的 Issue
    • 说明测试情况

代码规范

Python 代码风格

  • 遵循 PEP 8
  • 使用 4 个空格缩进
  • 变量名使用小写加下划线：my_variable
  • 类名使用驼峰命名：MyClass
  • 常量使用大写加下划线：MAX_STEPS

注释规范

def my_function(param1, param2):
    """
    函数的简短描述
    
    Args:
        param1: 参数1的描述
        param2: 参数2的描述
    
    Returns:
        返回值描述
    """
    pass

文档规范

  • 讲义使用 Markdown 格式
  • 代码示例要清晰、可运行
  • 添加必要的说明和图表

贡献类型

1. 代码贡献

  • 修复 Bug
  • 添加新功能
  • 优化性能
  • 改进示例代码

2. 文档贡献

  • 改进讲义内容
  • 修正错别字
  • 添加更多示例
  • 翻译成其他语言

3. 测试贡献

  • 添加测试用例
  • 测试不同环境
  • 报告测试结果

4. 其他贡献

  • 改进 README
  • 设计 Logo
  • 制作教程视频
  • 分享使用经验

行为准则

请遵守以下准则：

  • 尊重所有贡献者
  • 使用友好、包容的语言
  • 接受建设性批评
  • 关注项目的最佳利益
  • 展现同理心

问题？

如有任何问题，请：

再次感谢您的贡献！🎉