docs: add contribution guide

This commit is contained in:
Yafen 2025-09-02 15:13:39 +08:00
parent f869dc13c0
commit c0ac57a28f
7 changed files with 69 additions and 15 deletions

View File

@ -51,15 +51,16 @@ You can get introduction of openEuler SBC SIG from [sig-SBC](https://gitee.com/o
>- Recommendation: use the latest images provided in the chapter [How to download latest image](#how-to-download-latest-image) of this documentation.
- [documents](./documents/):
- [Raspberry Pi](documents/树莓派.md)
- [Getting started with Raspberry Pi](documents/树莓派.md)
- [How to contribute](documents/贡献指南.md)
- [Raspberry Pi](documents/RaspberryPi.md)
- [Getting started with Raspberry Pi](documents/RaspberryPi.md)
- [Install openEuler on an SD card](documents/raspberrypi/刷写镜像.md)
- [How to use Raspberry Pi](documents/raspberrypi/树莓派使用.md)
- [Building openEuler image for Raspberry Pi](documents/raspberrypi/openEuler镜像的构建.md)
- [Cross-compile the kernel](documents/raspberrypi/交叉编译内核.md)
- [Emulate Raspberry Pi with QEMU](documents/raspberrypi/QEMU启动树莓派.md)
- [Rockchip and other SoCs](documents/瑞芯微等开发板.md)
- [Getting started with Rockchip and other SoCs](documents/瑞芯微等开发板.md)
- [Rockchip and other SoCs](documents/Rockchip.md)
- [Getting started with Rockchip and other SoCs](documents/Rockchip.md)
- [Building openEuler image for Rockchip development boards](documents/rockchip/openEuler镜像的构建.md)
- [Install an Image on an EMMC](documents/rockchip/刷写EMMC镜像.md)
- [Build images sequentially](documents/rockchip/顺序构建.md)
@ -303,5 +304,5 @@ For other architecture hardware, you can use [QEMU](https://www.qemu.org/) to bu
### Run the scripts to build image
You can use the unified build scripts [build.sh](./scripts/build.sh) or [build-image-docker.sh](./scripts/build-image-docker.sh) to build images for Raspberry Pi, Rockchip, and other development boards, either directly on the host machine or by launching a Docker container. For details, please refer to the documentation below:
- [Build Raspberry Pi images](./documents/树莓派.md#构建镜像)
- [Build images for Rochchip and other SoCs](./documents/瑞芯微等开发板.md#镜像构建)
- [Build Raspberry Pi images](./documents/RaspberryPi.md#构建镜像)
- [Build images for Rochchip and other SoCs](./documents/Rockchip.md#镜像构建)

View File

@ -50,15 +50,16 @@ SIG 组基本信息位于 [sig-SBC](https://gitee.com/openeuler/community/tree/m
>- 建议直接使用本文档 [最新镜像](#最新镜像) 章节中给出的 openEuler 的树莓派/RK3399等镜像。
- [documents](./documents/): 使用文档
- [树莓派](documents/树莓派.md)
- [树莓派快速入门](documents/树莓派.md)
- [贡献指南](documents/贡献指南.md)
- [树莓派](documents/RaspberryPi.md)
- [树莓派快速入门](documents/RaspberryPi.md)
- [刷写镜像](documents/raspberrypi/刷写镜像.md)
- [树莓派使用](documents/raspberrypi/树莓派使用.md)
- [openEuler 镜像的构建](documents/raspberrypi/openEuler镜像的构建.md)
- [交叉编译内核](documents/raspberrypi/交叉编译内核.md)
- [QEMU 启动树莓派](documents/raspberrypi/QEMU启动树莓派.md)
- [瑞芯微等其他开发板](documents/瑞芯微等开发板.md)
- [瑞芯微等快速入门](documents/瑞芯微等开发板.md)
- [瑞芯微等其他开发板](documents/Rockchip.md)
- [瑞芯微等快速入门](documents/Rockchip.md)
- [openEuler镜像的构建](documents/rockchip/openEuler镜像的构建.md)
- [刷写EMMC镜像](documents/rockchip/刷写EMMC镜像.md)
- [顺序构建](documents/rockchip/顺序构建.md)
@ -302,5 +303,5 @@ SIG 组基本信息位于 [sig-SBC](https://gitee.com/openeuler/community/tree/m
### 构建镜像
镜像构建使用统一入口 [build.sh](./scripts/build.sh) 或 [build-image-docker.sh](./scripts/build-image-docker.sh) 在宿主机或者启动 Docker 容器构建树莓派或瑞芯微等开发板镜像。具体参考以下文档:
- [树莓派镜像构建](./documents/树莓派.md#构建镜像)
- [瑞芯微等开发板镜像构建](./documents/瑞芯微等开发板.md#镜像构建)
- [树莓派镜像构建](./documents/RaspberryPi.md#构建镜像)
- [瑞芯微等开发板镜像构建](./documents/Rockchip.md#镜像构建)

View File

@ -36,7 +36,7 @@
### 使用 BSP 内核
如果想使用 BSP 内核进行测试,可以在构建指令中指定 BSP 内核的仓库地址及对应分支,参考 [构建完整镜像](../瑞芯微等开发板.md#构建完整镜像)。
如果想使用 BSP 内核进行测试,可以在构建指令中指定 BSP 内核的仓库地址及对应分支,参考 [构建完整镜像](../Rockchip.md#构建完整镜像)。
## 准备 u-boot
@ -126,4 +126,4 @@ POST_BOARD_OVERLAY() {
## 运行测试
通过运行脚本 [构建完整镜像](../瑞芯微等开发板.md#构建完整镜像),将 `--board` 参数设置为新增开发板的版型文件来运行测试。
通过运行脚本 [构建完整镜像](../Rockchip.md#构建完整镜像),将 `--board` 参数设置为新增开发板的版型文件来运行测试。

View File

@ -122,7 +122,7 @@ dnf install git -y
## 容器内拉取并运行构建框架
过程参见[镜像构建](../瑞芯微等开发板.md#镜像构建)。
过程参见[镜像构建](../Rockchip.md#镜像构建)。
## 将容器内构建好的镜像复制到主机

52
documents/贡献指南.md Normal file
View File

@ -0,0 +1,52 @@
# 贡献指南
openEuler SBC SIG —— 诚挚邀请您的加入。
SBCsingle-board computerSIG 致力于将 openEuler 操作系统适配到各类单板计算机SBC包括但不限于树莓派Raspberry Pi、瑞芯微Rockchip等。其核心工作涵盖硬件适配、内核维护、镜像构建、社区协作及标准化推进旨在确保 openEuler 在 SBC 设备上的稳定运行和生态扩展。更多信息请参阅 [openEuler SBC SIG 介绍](https://gitee.com/openeuler/community/blob/master/sig/sig-SBC/README.md)。
SBC SIG 交流方式可参考:
- [openEuler 社区贡献说明](https://gitee.com/openeuler/community/blob/master/zh/contributors/README.md)
- [如何参与 SBC SIG](../README.md#如何参与-sig-组)
本文将以树莓派为例,介绍向 SBC SIG 贡献代码和文档的要求与规范。
### 内核源码
SBC SIG 维护的内核源码仓库包括:
- [树莓派内核](https://gitee.com/openeuler/raspberrypi-kernel)
- [瑞芯微内核](https://gitee.com/openeuler/rockchip-kernel)
- [飞腾内核](https://gitee.com/openeuler/phytium-kernel)
- [全志内核](https://gitee.com/openeuler/allwinner-kernel)
内核源码贡献相关流程如下:
1. 新增开发板适配需求:请在本仓库提交 ISSUE待需求审核通过并在 openEuler 社区创建对应内核仓库后,方可接受相关内核适配的 PR。
2. 现有内核(树莓派、瑞芯微、飞腾或全志)适配:请在对应内核仓库或本仓库提交 ISSUE并根据 ISSUE 提交新特性或内核修复的 PR。
### 镜像构建
SBC SIG 目前使用一套统一脚本构建各类开发板镜像,详见 [scripts](../scripts/)。主要包括:
- [构建完整镜像](../scripts/build.sh)
- [使用 Docker 构建完整镜像](../scripts/build-image-docker.sh)
- [构建 boot 镜像](../scripts/build_boot.sh)
- [构建 rootfs 镜像](../scripts/build_rootfs.sh)
- [编译 u-boot](../scripts/build_u-boot.sh)
- [将 u-boot、boot、rootfs 合并成一个完整镜像](../scripts/gen_image.sh)
- [构建开发板镜像的配置文件](../scripts/boards/),如构建树莓派镜像的配置文件为 [raspberrypi.conf](../scripts/boards/raspberrypi.conf)。
以添加树莓派镜像构建脚本为例,步骤如下:
1. 在 [scripts/boards](../scripts/boards/) 下添加构建树莓派镜像的配置文件:[raspberrypi.conf](../scripts/boards/raspberrypi.conf)。
2. 根据树莓派镜像构建需求,依次完善以下脚本:
- [构建 boot 镜像](scripts/build_boot.sh)
- [构建 rootfs 镜像](scripts/build_rootfs.sh)
- [编译 u-boot](scripts/build_u-boot.sh)
3. 完善脚本 [scripts/gen_image.sh](../scripts/gen_image.sh),将上述步骤生成的 u-boot、boot、rootfs 整合成一个完整镜像。
构建脚本命令及参数说明请参考:
1. [树莓派镜像构建](./RaspberryPi.md#构建镜像)
1. [瑞芯微等开发板镜像构建](./Rockchip.md#构建完整镜像)
### 文档
SBC SIG 维护的各类开发板构建与使用文档存放于 [documents](./)。以添加树莓派相关文档为例,应包含以下内容:
1. 在 [README.md](../README.md) 和 [README.en.md](../README.en.md) 中补充:
1. 树莓派相关文档列表:[文件说明](../README.md#文件说明)
2. [树莓派镜像下载列表](../README.md#树莓派)
3. [树莓派镜像构建方法](../README.md#构建镜像)
2. 在 [documents](./) 目录下添加树莓派的导航文档:[RaspberryPi.md](./RaspberryPi.md) ,文档名称为树莓派英文全称。
3. 在以树莓派英文全称命名的文件夹 [RaspberryPi](./RaspberryPi) 中归档所有树莓派相关文档。