Section outline

  • 用于开发

    如果您想尝试最新版本或为 RD-Agent 贡献代码,可以从源代码安装并按照本页的命令操作。

    git clone https://github.com/microsoft/RD-Agent

    🔧 准备开发环境

    设置开发环境:

    make dev

    运行代码检查(linting):

    make lint

    部分 linting 问题可以自动修复。我们已在 Makefile 中添加了相应的命令,方便使用:

    make auto-lint


    代码结构

    📂 src

    ➥ 📂 <项目名称>:避免命名空间冲突

    ➥ 📁 core

    ➥ 📁 components/A

    ➥ 📁 components/B

    ➥ 📁 components/C

    ➥ 📁 scenarios/X

    ➥ 📁 scenarios/Y

    ➥ 📂 app

    ➥ 📁 scripts

    文件夹名称 描述
    📁 core 系统的核心框架。所有类都应该是抽象的,通常不能直接使用。
    📁 component/A 可供其他部分(如场景)使用的有用组件。许多核心类的子类位于此文件夹中。
    📁 scenarios/X 针对特定场景的具体功能(通常基于组件或核心构建)。这些模块通常不可跨场景重用。
    📁 app 针对特定场景的应用程序(通常基于组件或场景构建)。移除任何一个都不会影响系统的完整性或其它场景。
    📁 scripts 临时且未优化的代码。这些是核心、组件、场景和应用程序的候选代码。

    命名规范

    名称 描述
    conf.py 模块、应用和项目的配置文件。