Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

53 lines (40 loc) · 2.76 KB
Raw

贡献指南

首先感谢您参与本开源项目，在您提交issue和pull request之前请认真阅读本指南

在提交pull request时一定要关联相应的issue，如果没有相应issue，请先创建issue
关于pull request关联issue，GitHub支持自动和手动关联，具体操作请参考Link PR to issue

issue和pull request填写时都支持Markdown，关于GitHub的Markdown语法和扩展请参考GitHub Flavored Markdown

提交issue

  1. 打开issue界面 https://github.com/kendryte/k510_buildroot/issues
  2. 查看issue列表中是否已经存在相似issue，如果没有请点击New issue按钮
  3. 根据您的问题类型，选择不同的issue模板
  4. 填写必须项后(带红色*标记)，点击Submit new issue按钮完成提交

提交pull request

  1. Fork本仓库到您的github
  2. Clone仓库到您本地
  3. 您可以基于main或dev分支创建新分支并添加更改git checkout -b newbranch -l main|dev
  4. 提交您的更改到您的github
  5. 进入您的github仓库点击Pull request按钮后点击New pull request按钮
  6. 选择base repository为kendryte/k510_buildroot，选择base为dev，选择head repository为yourname/k510_buildroot，选择compare为newbranch
  7. 根据pull request模板要求填写您的描述
  8. 点击Create pull request完成提交

如果您对以上流程还有不清楚的地方请参考GitHub PR Flow

生成linux和uboot补丁包

k510_buildroot中linux和uboot使用的是补丁包方式

如果需要修改kernel代码，请在kernel补丁目录package\patches\linux新增补丁文件
如果需要修改uboot代码，请在uboot补丁目录package\patches\uboot新增补丁文件

制作补丁时请提前做好代码修改备份，下面以k510_crb_lp3_v1_2_defconfig的linux补丁为例

cd k510_crb_lp3_v1_2_defconfig
make linux-dirclean
make linux-patch
cd build/linux-4.17
git init .
git add -f .
git commit -a -m "init"
#修改代码，比如 rm -rf README MAINTAINERS
git commit -m "delete README MAINTAINERS" README MAINTAINERS
git format-patch --no-renames -1
#生成补丁文件，执行完后可以看到类似 0001-delete-README-MAINTAINERS.patch 文件

把 0001-delete-README-MAINTAINERS.patch 重命名成一个比较大的名字比如 00100--delete-README-MAINTAINERS.patch 后，放到kernel补丁目录package\patches\linux，因为按从小到大的顺序打入补丁，请保证新加入的补丁名字最大

然后按照pull request流程提交补丁文件