From 66403b6591a6b877ba34f2837465e1649e9a5d2f Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 14:15:26 +0800 Subject: [PATCH 1/9] Update README.md Former-commit-id: 8b2c69babf81423bc4f09cf67f5b8198d7551633 --- cpp/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpp/README.md b/cpp/README.md index d32f04f316..31a774fb3e 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -8,7 +8,7 @@ Milvus is an open source vector search engine that supports similarity search of Milvus was developed by ZILLIZ, a tech startup that intends to reinvent data science, with the purpose of providing enterprises with efficient and scalable similarity search and analysis of feature vectors and unstructured data. -Milvus provides stable Python and C++ APIs, as well as RESTful API. +Milvus provides stable Python, C++ and Java API. Keep up-to-date with newest releases and latest updates by reading [Releases](https://www.milvus-io/docs/master/releases). From 8a53d8c9f151928271ffcf161636bd9e6d13120e Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 14:33:16 +0800 Subject: [PATCH 2/9] Update README.md Former-commit-id: 16c10a07a3d4632b4419174882b0d7cd7b75fa4e --- cpp/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cpp/README.md b/cpp/README.md index 31a774fb3e..be6254e866 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -1,3 +1,9 @@ + + + +- Slack Community(https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) +- Blog(https://www.milvus.io/blog/) + # Welcome to Milvus Firstly, welcome, and thanks for your interest in [Milvus](https://milvus.io)! No matter who you are, what you do, we greatly appreciate your contribution to help us reinvent data science with Milvus. From 1f99ab1c7a4d2863e0e996ccebfcbacab60b6b46 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 14:33:36 +0800 Subject: [PATCH 3/9] Update README.md Former-commit-id: 41bfed06d0b2ee0970e99873f22e008780988f30 --- cpp/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index be6254e866..2d0bef0f29 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -1,8 +1,7 @@ - -- Slack Community(https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) -- Blog(https://www.milvus.io/blog/) +- [Slack Community](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) +- [Blog](https://www.milvus.io/blog/) # Welcome to Milvus From 30925f759bc3c924cd039d5719a51a12e6c8bbf8 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 14:37:26 +0800 Subject: [PATCH 4/9] Update README.md Former-commit-id: 0ca186c1fd21c7dadcf6f892a210e9d3b8925696 --- cpp/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index 2d0bef0f29..1943a4be7f 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -1,5 +1,4 @@ - - [Slack Community](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) - [Blog](https://www.milvus.io/blog/) @@ -38,7 +37,7 @@ Keep up-to-date with newest releases and latest updates by reading [Releases](ht #### Use Docker -Use Docker to install Milvus is a breeze. See the [Milvus install guide](https://www.milvus-io/docs/master/userguide/install_milvus.md) for details. +Use Docker to install Milvus is a breeze. See the [Milvus install guide](https://milvus.io/docs/en/userguide/install_milvus/) for details. #### Use source code From f1c40f44407c3a49bde28151c1fcf50cad612774 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 14:56:38 +0800 Subject: [PATCH 5/9] Update README.md Former-commit-id: f418eaa3b6a769e6f07552a21e2f947d845f7851 --- cpp/README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index 1943a4be7f..fcc5a27027 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -1,4 +1,3 @@ - - [Slack Community](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) - [Blog](https://www.milvus.io/blog/) @@ -12,9 +11,9 @@ Milvus is an open source vector search engine that supports similarity search of Milvus was developed by ZILLIZ, a tech startup that intends to reinvent data science, with the purpose of providing enterprises with efficient and scalable similarity search and analysis of feature vectors and unstructured data. -Milvus provides stable Python, C++ and Java API. +Milvus provides stable Python, C++ and Java APIs. -Keep up-to-date with newest releases and latest updates by reading [Releases](https://www.milvus-io/docs/master/releases). +Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://milvus.io/docs/en/Releases/v0.4.0/). - GPU-accelerated search engine @@ -184,17 +183,17 @@ $ python3 example.py ## Contribution guidelines -Contributions are welcomed and greatly appreciated. If you want to contribute to Milvus, please read the [contribution guidelines](CONTRIBUTING.md). This project adheres to the [code of conduct](CODE OF CONDUCT.md) of Milvus. By participating, you are expected to uphold this code. +Contributions are welcomed and greatly appreciated. If you want to contribute to Milvus, please read our [contribution guidelines](CONTRIBUTING.md). This project adheres to the [code of conduct](CODE OF CONDUCT.md) of Milvus. By participating, you are expected to uphold this code. -We use [GitHub issues](https://github.com/milvus-io/milvus/issues) to track issues and bugs. For general questions and discussions, please go to [Milvus Forum]. +We use [GitHub issues](https://github.com/milvus-io/milvus/issues) to track issues and bugs. For general questions and public discussions, please join our community. ## Join the Milvus community -For public discussion of Milvus, please join our [discussion group](milvusio.slack.com). +To connect with other users and contributors, welcome to join our [slack channel](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk). ## Milvus Roadmap -Please read our [roadmap](milvus-io/milvus/docs/master/roadmap.md) to learn about upcoming features. +Please read our [roadmap](https://milvus.io/docs/en/roadmap/) to learn about upcoming features. ## Resources @@ -206,7 +205,7 @@ Please read our [roadmap](milvus-io/milvus/docs/master/roadmap.md) to learn abou [Milvus CSDN](https://mp.csdn.net/mdeditor/100041006#) -[Milvus roadmap](https://www.milvus-io/docs/master/roadmap.md) +[Milvus roadmap](https://milvus.io/docs/en/roadmap/) ## License From 0339a93aed0977c851f83bd70e834a3282c4d927 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 15:08:29 +0800 Subject: [PATCH 6/9] Update CONTRIBUTING.md Former-commit-id: 1cd9de3f3556277bd9c798a2a6eec16ff5dbc921 --- cpp/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md index 9e23d6b0ed..a10cb9cc49 100644 --- a/cpp/CONTRIBUTING.md +++ b/cpp/CONTRIBUTING.md @@ -4,7 +4,7 @@ First of all, thanks for taking the time to contribute to Milvus! It's people li The following are a set of guidelines for contributing to Milvus. Following these guidelines helps contributing to this project easy and transparent. These are mostly guideline, 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](http://hood.ie/code-of-conduct/). +As for everything else in the project, the contributions to Milvus are governed by our [Code of Conduct](CODE_OF_CONDUCT.md). TOC From 84f77debca9dcc1c157cd0a46017b280863b908c Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 15:09:06 +0800 Subject: [PATCH 7/9] Update CONTRIBUTING.md Former-commit-id: a8c9caa337275e27efc7f9ba38486942b1b76792 --- cpp/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md index a10cb9cc49..3be9b7248b 100644 --- a/cpp/CONTRIBUTING.md +++ b/cpp/CONTRIBUTING.md @@ -4,7 +4,7 @@ First of all, thanks for taking the time to contribute to Milvus! It's people li The following are a set of guidelines for contributing to Milvus. Following these guidelines helps contributing to this project easy and transparent. These are mostly guideline, 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](CODE_OF_CONDUCT.md). +As for everything else in the project, the contributions to Milvus are governed by our [Code of Conduct](CODE OF CONDUCT.md). TOC From f10b7ed8b057c4b6b47fd065e0bb3c66bc0d81df Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 15:18:23 +0800 Subject: [PATCH 8/9] Update CONTRIBUTING.md Former-commit-id: c00ea6cb77a7fa35c2ccc864226af5fbb18a64ea --- cpp/CONTRIBUTING.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md index 3be9b7248b..0d9e30f678 100644 --- a/cpp/CONTRIBUTING.md +++ b/cpp/CONTRIBUTING.md @@ -36,8 +36,8 @@ The Milvus team members will review your pull requests, and once it is accepted, Before sending your pull requests for review, make sure your changes are consistent with the guidelines and follow the Milvus coding style. -- Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost. -- Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage. +- Include unit tests when you contribute new features, as they help to prove that your code works correctly, and also guard against future breaking changes to lower the maintenance cost. +- Bug fixes also require unit tests, because the presence of bugs usually indicates insufficient test coverage. - Keep API compatibility in mind when you change code in Milvus. Reviewers of your pull request will comment on any API compatibility issues. - When you contribute a new feature to Milvus, the maintenance burden is (by default) transferred to the Milvus team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature. @@ -49,8 +49,6 @@ Before sending your pull requests for review, make sure your changes are consist ```shell $ ./build.sh -u -or -$ ./build.sh --unittest ``` From dc273ae4acb1be6aa8495b1b85f12fcfc787d104 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 25 Sep 2019 16:09:18 +0800 Subject: [PATCH 9/9] Update CONTRIBUTING.md Former-commit-id: 1d9bda6fbbe40be5562dd6f6d03910c5ab5fc5f6 --- cpp/CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md index 0d9e30f678..8711d87050 100644 --- a/cpp/CONTRIBUTING.md +++ b/cpp/CONTRIBUTING.md @@ -43,11 +43,22 @@ Before sending your pull requests for review, make sure your changes are consist ## Coding Style +The coding style used in Milvus generally follow [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html). +And we made the following changes based on the guide: + +- 4 spaces for indentation +- Adopt .cpp file extension instead of .cc extension +- 120-character line length +- The file name starts with the upper case ## Run unit test +We use Google Test framework for test running. +To run unit test for Milvus under C++, please use the following command: + ```shell +# Run unit test for Milvus $ ./build.sh -u ```