Merge branch 'branch-0.5.0' into 'branch-0.5.0'

Branch 0.5.0

See merge request megasearch/milvus!574

Former-commit-id: d430ebb10f3717ff1dea05d1faadccd4dd75e0e7

cpp/CHANGELOG.md

@@ -18,6 +18,7 @@ Please mark all change in change log and use the ticket from JIRA.
 
 ## Task
 - MS-554 - Change license to Apache 2.0
+- MS-561 - Add contributing guidelines, code of conduct and README docs
 
 # Milvus 0.4.0 (2019-09-12)
 

cpp/CODE OF CONDUCT.md

+# Milvus Code of Conduct
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language.
+- Being respectful of differing viewpoints and experiences.
+- Gracefully accepting constructive criticism.
+- Focusing on what is best for the community.
+- Showing empathy towards other community members.
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances.
+- Trolling, insulting/derogatory comments, and personal or political attacks.
+- Public or private harassment.
+- Publishing others' private information, such as a physical or electronic address, without explicit permission.
+- Conduct which could reasonably be considered inappropriate for the forum in which it occurs.
+
+All Milvus forums and spaces are meant for professional interactions, and any behavior which could reasonably be considered inappropriate in a professional setting is unacceptable.
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies to all content on milvus.io, Milvus’s GitHub organization, or any other official Milvus web presence allowing for community interactions, as well as at all official Milvus events, whether offline or online.
+
+The Code of Conduct also applies within all project spaces and in public spaces whenever an individual is representing Milvus or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed or de facto representative at an online or offline event. Representation of Milvus may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@zilliz.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
+

cpp/CONTRIBUTING.md

+# Contributing to Milvus
+
+First of all, thanks for taking the time to contribute to Milvus! It's people like you that help Milvus come to fruition.
+
+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/).
+
+TOC
+
+## Contribution Checklist
+
+Before you make any contributions, make sure you follow this list.
+
+- Read [Contributing to Milvus](CONTRIBUTING.md).
+- Check if the changes are consistent with the [coding style](CONTRIBUTING.md#coding-style).
+- Run [unit tests](CONTRIBUTING.md#run-unit-test).
+
+## What contributions can I make?
+
+Contributions to Milvus fall into the following categories.
+
+1. To report a bug or a problem with documentation, please file an [issue](https://github.com/milvus-io/milvus/issues/new) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team.
+2. To propose a new feature, please file a new feature request [issue](https://github.com/milvus-io/milvus/issues/new). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code].
+3. To implement a feature or bug-fix for an existing outstanding issue, follow the [Contributing code]. If you need more context on a particular issue, comment on the issue to let people know.
+
+## How can I contribute?
+
+### Contributing code
+
+If you have improvements to Milvus, send us your pull requests! For those just getting started, GitHub has a [how-to](https://help.github.com/en/articles/about-pull-requests).
+
+The Milvus team members will review your pull requests, and once it is accepted, it will be given a `ready to merge` label. 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.
+
+### General guidelines
+
+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.
+- 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
+
+## Run unit test
+
+```shell
+$ ./build.sh -u
+or
+$ ./build.sh --unittest
+```
+
+

cpp/README.md

-### Compilation
-#### Step 1: install necessery tools
+# Welcome to Milvus
 
-    centos7 : 
-        yum install gfortran qt4 flex bison mysql-devel mysql
-        
-    ubuntu16.04 : 
-        sudo apt-get install gfortran qt4-qmake flex bison libmysqlclient-dev mysql-client
-        
-    cd scripts && sudo ./requirements.sh     
+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.
 
-If `libmysqlclient_r.so` does not exist after installing MySQL Development Files, you need to create a symbolic link:
+## What is Milvus
 
+Milvus is an open source vector search engine that makes incredibly fast querying speed enhancement over current solutions of massive vector processing. Built on optimized indexing algorithm, it is compatible with major AI/ML models.
+
+Milvus was developed by researchers and engineers in 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.
+
+Keep up-to-date with newest releases and latest updates by reading [Releases](https://www.milvus-io/docs/master/releases).
+
+- GPU-accelerated search engine
+
+  Milvus is designed for the largest scale of vector index. CPU/GPU heterogeneous computing architecture allows you to process data at a speed 1000 times faster.
+
+- Intelligent index
+
+  With a “Decide Your Own Algorithm” approach, you can embed machine learning and advanced algorithms into Milvus without the headache of complex data engineering or migrating data between disparate systems. Milvus is built on optimized indexing algorithm based on quantization indexing, tree-based and graph indexing methods.
+
+- Strong scalability
+
+  The data is stored and computed on a distributed architecture. This lets you scale data sizes up and down without redesigning the system.
+
+## Architecture
+![Milvus_arch](https://www.milvus-io/docs/master/assets/milvus_arch.png)
+
+## Get started
+
+### Install and start Milvus server
+
+#### 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 source code
+
+##### Compilation
+
+###### Step 1 Install necessary tools
+
+```shell
+# Install tools
+Centos7 : 
+$ yum install gfortran qt4 flex bison mysql-devel mysql
+    
+Ubuntu16.04 : 
+$ sudo apt-get install gfortran qt4-qmake flex bison libmysqlclient-dev mysql-client
+       
+```
+
+Verify the existence of `libmysqlclient_r.so`:
+
+```shell
+# Verify existence
+$ locate libmysqlclient_r.so
 ```
-sudo ln -s /path/to/libmysqlclient.so /path/to/libmysqlclient_r.so
+
+If not, you need to create a symbolic link:
+
+```shell
+# Create symbolic link
+$ sudo ln -s /path/to/libmysqlclient.so /path/to/libmysqlclient_r.so
 ```
 
-#### Step 2: build(output to cmake_build folder)
+###### Step 2 Build
 
-cmake_build/src/milvus_server is the server
+```shell
+TBD
+cd [Milvus sourcecode path]/cpp/thirdparty
+git clone git@192.168.1.105:megasearch/knowhere.git
+cd knowhere
+./build.sh -t Debug
+or ./build.sh -t Release
 
-    cd [sourcecode path]/cpp/thirdparty
-    git clone git@192.168.1.105:megasearch/knowhere.git
-    cd knowhere
-    ./build.sh -t Debug
-    or ./build.sh -t Release
+cd [sourcecode path]/cpp
+./build.sh -t Debug
+or ./build.sh -t Release
+```
 
-    cd [sourcecode path]/cpp
-    ./build.sh -t Debug
-    or ./build.sh -t Release
+When the build is completed, all the stuff that you need in order to run Milvus will be installed under `[Milvus root path]/cpp/milvus`.
 
-If you encounter the following error when building:
+If you encounter the following error message,
 `protocol https not supported or disabled in libcurl`
 
-1. Install libcurl4-openssl-dev
-
-2. Install cmake 3.14: 
+please reinstall CMake with curl:
 
+1. Install curl development files:
+   ```shell
+   CentOS 7:   
+   $ yum install curl-devel
+   Ubuntu 16.04: 
+   $ sudo apt-get install libcurl4-openssl-dev
    ```
-   ./bootstrap --system-curl 
-   make 
-   sudo make install
+
+2. Install [CMake 3.14](https://github.com/Kitware/CMake/releases/download/v3.14.6/cmake-3.14.6.tar.gz): 
+   ```shell
+   $ ./bootstrap --system-curl 
+   $ make 
+   $ sudo make install
    ```
 
-#### To build unittest:
+##### Run unit test
+
+```shell
+$ ./build.sh -u
+or
+$ ./build.sh --unittest
+```
 
-    ./build.sh -u
-    or
-    ./build.sh --unittest
+##### Run code coverage
 
-#### To run code coverage
+```shell
+CentOS 7:   
+$ yum install lcov
+Ubuntu 16.04: 
+$ sudo apt-get install lcov
+    
+$ ./build.sh -u -c
+```
 
-    apt-get install lcov
-    ./build.sh -u -c
+##### Launch Milvus server
 
-### Launch server
-Set config in cpp/conf/server_config.yaml
+```shell
+$ cd [Milvus root path]/cpp/milvus
+```
 
-Add milvus/lib to LD_LIBRARY_PATH
+Add `lib/` directory to `LD_LIBRARY_PATH`
 
 ```
-export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/milvus/lib
+$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/milvus/lib
+```
+
+Then start Milvus server:
+
 ```
+$ cd scripts
+$ ./start_server.sh
+```
+
+To stop Milvus server, run:
+
+```shell
+$ ./stop_server.sh
+```
+
+To edit Milvus settings in `conf/server_config.yaml` and `conf/log_config.conf`, please read [Milvus Configuration](https://www.milvus-io/docs/master/reference/milvus_config.md).
+
+### Try your first Milvus program
+
+#### Run Python example code
+
+Make sure [Python 3.4](https://www.python.org/downloads/) or higher is already installed and in use.
+
+Install Milvus Python SDK.
+
+```shell
+# Install Milvus Python SDK
+$ pip install pymilvus==0.2.0
+```
+
+Create a new file `example.py`, and add [Python example code](https://github.com/milvus-io/pymilvus/blob/branch-0.3.1/examples/AdvancedExample.py) to it.
+
+Run the example code.
+
+```python
+# Run Milvus Python example
+$ python3 example.py
+```
+
+#### Run C++ example code
+
+```shell
+ # Run Milvus C++ example
+ $ cd [Milvus root path]/cpp/milvus/bin
+ $ ./sdk_simple
+```
+
+## 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.
+
+We use [GitHub issues] to track issues and bugs. For general questions and discussions, please go to [Milvus Forum]. 
+
+## Join the Milvus community
+
+For public discussion of Milvus, please join our [discussion group]. 
+
+## Milvus Roadmap
+
+Please read our [roadmap](milvus-io/milvus/docs/master/roadmap.md) to learn about upcoming features.
+
+## Resources
+
+[Milvus official website](https://milvus.io)
+
+[Milvus docs](https://www.milvus.io/docs/en/QuickStart/)
+
+[Milvus blog](https://www.milvus.io/blog/)
+
+[Milvus CSDN](https://mp.csdn.net/mdeditor/100041006#)
+
+[Milvus roadmap](https://www.milvus-io/docs/master/roadmap.md)
+
+[Milvus white paper]
 
-Then launch server with config:
-    cd [build output path]
-    start_server.sh
-    stop_server.sh
+## License
 
-### Launch test_client(only for debug)
-If you want to test remote api, you can run sdk example.
-    [build output path]/sdk/examples/grpcsimple/sdk_simple
+[Apache 2.0 license](milvus-io/milvus/LICENSE.md)
\ No newline at end of file