diff --git a/.git-commit-template b/.git-commit-template index 457b43fc6eaaedfb159008748c86aaa46076b496..4338fd12c4c028dd0260d4bdf348f80e3a3631a3 100644 --- a/.git-commit-template +++ b/.git-commit-template @@ -27,5 +27,5 @@ # 5. body 每行 72 个字 # 6. body 用于解释为什么和是什么,而不是怎么做 # 7. footer 暂时无需填写 -# 8. scope 可选，建议填写为受影响的 base-image 或 project +# 8. scope 可选，建议填写为受影响的 base-image 或 repo # ----------------------------------------- diff --git a/README.md b/README.md index 1891d6f702546eac6b3699d9aae23a72880cdbfb..0ad9b7cf7104e16e7a402fd9fa120bf49dcbaa68 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ -### OSS-Fuzz 项目简介 - - - ### OSS-Fuzz 移植项目简介 #### 项目需求 @@ -22,11 +18,16 @@ 5. 自动化用例 6. 测试报告 +#### 项目相关链接 + +- [项目管理文档](https://docs.qq.com/sheet/DSEdBWHJYbFdBa2xj?u=3e90927134394f638bdb49b5eeb21229&tab=BB08J2) +- [OSS-Fuzz GitHub 主页](https://github.com/google/oss-fuzz) + ### OSS-Fuzz 官方介绍 [OSS-Fuzz-README.md](https://gitee.com/jasonchio/oss-fuzz-openeuler/blob/master/OSS-Fuzz-README.md) -### Ubuntu --> openEuler 移植思路 +### 基础镜像移植思路 移植思路： @@ -38,14 +39,49 @@ - 如果没有同名包，则安装相同作用的包（`apt-get install -y libc6-dev` --> `yum install -y glibc-devel`） 4. 构建基于 openEuler 的镜像（`docker build -t fuzz-base-image:alpha1 .`），根据构建过程中的错误 log 修改 Dockerfile 直至镜像构建成功 -### 设置 git 用户名及邮箱 +### openEuler repo 源替换 + +备份 repo 源 + +```shell +cp /etc/yum.repos.d/openEuler.repo /etc/yum.repos.d/openEuler.repo.bak +``` + +将仓库中 docs/whut/openeuler_x86-64.repo.txt 文件中的内容复制到 `openEuler.repo` 中（检查是否复制完全），重新生成缓存 + +```shell +yum clean all +yum makecache +``` + +### 项目仓库的 fork 及基本设置 + +#### fork 项目 + +加入项目主仓库之后，界面右上角（头像下面）会有 Fork 按钮，点击该按钮将项目 fork 到个人仓库中。 + +![Gitee 个人仓库](https://gitee.com/jasonchio/oss-fuzz-openeuler/raw/master/docs/images/gitee-private-repos.png) + +#### clone + +在项目主页复制项目 Git 链接 + +![copy-gitee-link](https://gitee.com/jasonchio/oss-fuzz-openeuler/raw/master/docs/images/copy-gitee-link.png) + +将项目克隆到本地 + +```shell +git clone repo_link +``` + +#### 设置 git 用户名及邮箱 ```bash git config --global user.name "你的用户名" git config --global user.email "你注册时候的邮箱" ``` -### 免密 push +#### 免密 push 解决 git push 时每次都需要输入用户名和密码的问题 ```bash # oss-fuzz-openeuler 目录下输入 @@ -55,7 +91,61 @@ git push # 输入账号密码后，下次 push 就不用输入了 ```` -### git commit message 规范 +#### 提交修改 + +1. `git status`查看有变动的文件 + + ![git-status](https://gitee.com/jasonchio/oss-fuzz-openeuler/raw/master/docs/images/git-status.png) + +2. `git add .`将所有有变动的文件都加入到暂存区 + + ![git-add](https://gitee.com/jasonchio/oss-fuzz-openeuler/raw/master/docs/images/git-add.png) + +3. `git commit`填写 commit message，将修改提交 + + ![git-commit](https://gitee.com/jasonchio/oss-fuzz-openeuler/raw/master/docs/images/git-commit.png) + +4. `git push`将修改提交到 Gitee 仓库（支持多次 commit 操作之后一起提交到 Gitee 仓库） + + ![git-push](https://gitee.com/jasonchio/oss-fuzz-openeuler/raw/master/docs/images/git-push.png) + +5. 完成一次变动提交 + +#### git commit message 规范 + +设定项目提交模板 + +```shell +git config --global commit.template .git-commit-template +``` + +在编写 commit message 时，遵循以下规范 + +```shell +():space +blank line + +blank line +