加入私有/第三方的代码

我们欢迎任何人进行贡献,但是并不是所有的代码都可以被合并到主线当中。有些开发者想要私有化自己的代码,比如因为版权和商业问题并不能公开。有的有较多的代码质量问题,或者只是现有模块的简单修改,我们并不接受这样的代码。因此我们提供了另一种方式,可以将你自己代码以另一种方式加入到此项目的构建中。

用户文件夹

在工程主目录下有一个名为user的文件夹,其结构如下

.
├── bsp
│   └── .gitkeep
├── component
│   └── .gitkeep
├── device
│   └── .gitkeep
├── lib
│   └── .gitkeep
├── module
│   └── .gitkeep
├── robot
│   └── .gitkeep
└── system
    └── .gitkeep

你可以参考 https://github.com/orgs/xrobot-org/repositories页面中以demo-开头的仓库,其编写方式与原生的模块基本相同,然后创建你自己的仓库并克隆到对应文件夹。例如:

.
├── bsp
│   ├── demo-board
│   └── .gitkeep
├── component
│   ├── demo-component
│   └── .gitkeep
├── device
│   ├── demo-device
│   └── .gitkeep
├── lib
│   └── .gitkeep
├── module
│   ├── demo-module
│   └── .gitkeep
├── robot
│   ├── demo-robot
│   └── .gitkeep
└── system
    └── .gitkeep

这样就可以把你自己私有的代码当成XRobot原生的模块使用,在config中也能够进行选择。

CI/CD demo

加入第三方代码进行自动构建,并发布固件的示例。

xrobot-org/user_project_demo: Demo for user project. (github.com)