kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: add dco and backport to code-contribute-guide (#671) 

* Docs: add dco and backport to code-contribute guide

Signed-off-by: fourierr <maxiangboo@qq.com>

* Docs: add dco and backport to code-contribute guide

Signed-off-by: fourierr <maxiangboo@qq.com>
This commit is contained in:
Xiangbo Ma 2022-05-23 12:03:34 +08:00 committed by GitHub
parent ca08d2ac16
commit e85dae6cef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/contributor/code-contribute.md
View File

@ -229,6 +229,7 @@ If the pull request fixes a bug:
- The pull request description must include `Closes #<issue number>` or `Fixes #<issue number>`.
- To avoid regressions, the pull request should include tests that replicate the fixed bug.
- If this pull request fixes a bug that needs to backport releases, you can add `backport release-x.x` label to automatically backport this PR to release-x.x branch.
## Code review
@ -346,8 +347,18 @@ Make sure that the title for your pull request uses the same format as the subje
### Pass all the CI checks
Before merge, All test CI should pass green.
The `codecov/project` should also pass. This means the coverage should not drop.
- The `codecov/project` should also pass. This means the coverage should not drop. Currently, the coverage of the Pull Request should have at least 70%.
- KubeVela uses [DCO](https://wiki.linuxfoundation.org/dco) for contributor agreements. It requires you to sign-off every commit before the pull request being merged.
- Git provides a convenient flag `-s` in your commit command to sign-off automatically:
```shell
git commit -s -m 'This is my commit message'
```
- Contributors can also sign-off manually by adding a `Signed-off-by` line to commit messages as the following format, make sure the email matches your github account or the check bot won't pass.
```shell
This is my commit message
Signed-off-by: Random Developer <random@developer.example.org>
```
## Update the docs & website
If your pull request merged and this is a new feature or enhancement, it's necessary to update the docs and send a pull request to [kubevela.io](https://github.com/kubevela/kubevela.io) repo.