diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md index 9e23d6b0ed54458ba6b7fd3f8fea85967430bad4..8711d8705047d1c737c15e9c5ba39b0ae940c901 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 @@ -36,21 +36,30 @@ 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. ## 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 -or -$ ./build.sh --unittest ``` diff --git a/cpp/README.md b/cpp/README.md index 7c3d28e5808cb362eba81de516c0f83d5256d590..57f3a85dccd921479cd6be41f3bec7fe1112a057 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -1,3 +1,6 @@ +- [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. @@ -8,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 and C++ APIs, as well as RESTful 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 @@ -33,7 +36,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 @@ -185,17 +188,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 @@ -207,7 +210,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