同步操作将从 milvus-io/milvus 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
Contributions to Milvus are welcome from everyone. We strive to make the contribution process simple and straightforward. Up-to-date information can be found at milvus.io.
The following are a set of guidelines for contributing to Milvus. Following these guidelines makes contributing to this project easy and transparent. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
As for everything else in the project, the contributions to Milvus are governed by our Code of Conduct.
Contributions to Milvus fall into the following categories.
If you have improvements to Milvus, send us your pull requests! For those just getting started, see GitHub workflow. Make sure to refer to the related issue in the ccomment of your pull request and update CHANGELOG.md.
All submissions will be reviewed as quickly as possible. Once it is accepted, the status of the project to which it is associated will be changed to Reviewer approved. This means we are working on submitting your pull request to the internal repository. After the change has been submitted internally, your pull request will be merged automatically on GitHub.
Generally, we follow the "fork-and-pull" Git workflow.
git clone git@github.com:<yourname>/milvus.git
.git checkout -b my-topic-branch
.git push --set-upstream origin my-topic-branch
. You must record your changes in CHANGELOG.md with issue numbers and descriptions.Remember to sync your forked repository before submitting proposed changes upstream. If you have an existing local repository, please update it before you start, to minimize the chance of merge conflicts.
git remote add upstream git@github.com:milvus-io/milvus.git
git checkout master
git pull upstream master
git checkout -b my-topic-branch
Before submitting your pull requests for review, make sure that your changes are consistent with the coding style, and run unit tests to check your code coverage rate.
All contributions to this project must be accompanied by acknowledgment of, and agreement to, the Developer Certificate of Origin. Acknowledgment of and agreement to the Developer Certificate of Origin must be included in the comment section of each contribution and must take the form of Signed-off-by: {{Full Name}} <{{email address}}>
(without the {}
). Contributions without this acknowledgment will be required to add it before being accepted. If contributors are unable or unwilling to agree to the Developer Certificate of Origin, their contribution will not be included.
Contributors sign-off that they adhere to DCO by adding the following Signed-off-by line to commit messages:
This is my commit message
Signed-off-by: Random J Developer <random@developer.example.org>
Git also has a -s
command line option to append this automatically to your commit message:
$ git commit -s -m 'This is my commit message'
The coding style used in Milvus generally follow Google C++ Style Guide. And we made the following changes based on the guide:
Install clang-format
$ sudo apt-get install clang-format
$ rm cmake_build/CMakeCache.txt
Check code style
$ ./build.sh -l
To format the code
$ cd cmake_build
$ make clang-format
Before submitting your Pull Request, make sure you have run unit test, and your code coverage rate is >= 90%.
Install lcov
$ sudo apt-get install lcov
Run unit test and generate code for code coverage check
$ ./build.sh -u -c
Run MySQL docker
docker pull mysql:latest
docker run -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 -d mysql:latest
Run code coverage
$ ./coverage.sh -u root -p 123456 -t 127.0.0.1
Or start your own MySQL server, and then run code coverage
$ ./coverage.sh -u ${MYSQL_USERNAME} -p ${MYSQL_PASSWORD} -t ${MYSQL_SERVER_IP}
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。