OpenHarmony社区开发流程入门指导

目录

1. 社区账号及DCO协议签署

1.1 申请注册社区账号

1.2 签署DCO

1.3 社区领取issues任务及获取issues号

1.3.1 Issues预览

1.3.2 获取issues号

2. 开发环境准备

2.1 下载VMware及Ubuntu虚拟机

2.2 安装VMare并创建Ubuntu虚拟机

2.3 Linux环境基础配置

2.3.1 解锁root用户

2.3.2 安装网络工具并查看本机IP用于ssh远程登录

2.3.3 开启ssh服务并用putty连接虚拟机（可选）

2.3.4 开启samba服务并用windows文件服务访问对应目录（可选）

3. 配置Linux开发环境及下载代码

3.1 使用一键式安装脚本进行环境配置

3.2 配置公钥

3.3 代码下载及编译

 3.4 各类开发板编译方式

4. 提交PR步骤

4.1 fork代码仓到个人账户

4.2 clone个人仓到本地修改

4.2.1 到个人仓下——选择“克隆/下载”——复制链接：

 4.2.2 本地使用clone命令进行clone

4.3 代码提交步骤

4.3.1 本地代码提交到远程个人仓

4.3.2 个人仓提交PR合入master

---

1. 社区账号及DCO协议签署

1.1 申请注册社区账号

登录码云并使用常用邮箱进行注册，该邮箱需要用来签署DCO

Gitee - 基于 Git 的代码托管和研发协作平台https://gitee.com/

1.2 签署DCO

签署OpenHarmony DCO（Developer Certificate of Origin，开发者原创声明），并遵守原创契约。使用邮箱签署后，需要在邮箱进行确认。

DCOhttps://dco.openharmony.io/sign-dco

1.3 社区领取issues任务及获取issues号

issues被用来追踪各种想法,增强功能,任务,bug等，是社区开发代码的一个任务标签，合入代码及多仓关联构建都需要使用到issues号。

1.3.1 Issues预览

issues举例

issues包含了“任务描述”、“解决方案”、“任务来源等几个要素”

1.3.2 获取issues号

点击任意issues——进入issues后点击#号进行复制issues号，用于提交PR时关联issues。

2. 开发环境准备

2.1 下载VMware及Ubuntu虚拟机

VMware下载地址

推荐版本号-16.1.2-17966106

Ubuntu下载地址

推荐版本号-20.04.2

2.2 安装VMare并创建Ubuntu虚拟机

1. 选择创建虚拟机

2. 选择对应Ubuntu的iso镜像文件

3. 后续添加用户名后点击下一步默认安装即可 

4. 需要注意的是，在选择磁盘容量的时候，尽可能填写一个大的虚拟内存，建议填800G以上：

 

5. 置用户名后，选择语言，之后每个过程选择“Done”即可：

6.  安装完成标志（全程耗时约1h）：

 

2.3 Linux环境基础配置

2.3.1 解锁root用户

root用户是Linux系统的最高权限用户，新安装的环境需要解锁，否则很多基础功能无法使用。

# 创建没有密码的root用户
sudo passwd -u root
# 修改root用户密码
sudo passwd root

解锁方式详情参考

2.3.2 安装网络工具并查看本机IP用于ssh远程登录

未安装网络工具，则无法使用ifconfig等网络工具命令，安装命令如下：

# 安装net-tools
sudo apt-get install net-tools
# 查看本机IP
ifconfig

2.3.3 开启ssh服务并用putty连接虚拟机（可选）

使用putty等ssh客户端连接虚拟机可以带来更舒适的Linux虚拟机的使用体验。

sudo apt-get install ssh
vi /etc/ssh/sshd_config
# 去除Authentication
后面五行注释，PermiRootLogin 后面字段改为yes
/etc/init.d/ssh resart

2.3.4 开启samba服务并用windows文件服务访问对应目录（可选）

如何开启Samba服务

3. 配置Linux开发环境及下载代码

3.1 使用一键式安装脚本进行环境配置

脚本使用教程

3.2 配置公钥

经过步骤3.1后，已完成SHH公钥生成，配置到码云后即可使用。

查看公钥：

cat ~/.ssh/id_rsa.pub

码云配置公钥：

码云主页——设置——安全设置——ssh公钥——添加公钥及标题即可

3.3 代码下载及编译

经过步骤3.1配置过码云账号、邮箱后，直接使用repo+ssh方式下载即可：

# 创建代码目录
mkdir -p openharmony_code
cd openharmony_code
# 初始化代码仓配置文件
repo init -u git@gitee.com:openharmony/manifest.git -b master --no-repo-verify
# 同步代码、大文件、编译工具
repo sync -c
repo forall -c 'git lfs pull'
bash build/prebuilts_download.sh

详细过程可参考OpenHarmony源码下载指导

 3.4 各类开发板编译方式

不同开发板的编译方式-参考入门介绍

4. 提交PR步骤

4.1 fork代码仓到个人账户

fork代码仓，用于个人代码修改提交，提交到个人分支后的代码需要提PR才能合入master。

fork举例，fork代码到个人名下：

4.2 clone个人仓到本地修改

4.2.1 到个人仓下——选择“克隆/下载”——复制链接：

 4.2.2 本地使用clone命令进行clone

4.3 代码提交步骤

4.3.1 本地代码提交到远程个人仓

修改代码后，在代码仓下（包含.git文件夹）执行

# 添加修改文件(可指定具体文件或指定当前仓路径)
git add .
# 添加commit信息说明及添加dco签署标签
git commit -sm "commit msg"
# 推送代码到远程个人仓
git push origin master

4.3.2 个人仓提交PR合入master

推送代码后，到个人仓下点击pull request进行代码合入master申请

在关联issues号后，点击确认；

在确认后评论“start build”发起构建；

构建通过后，committerreview加分后，即可合入master；