mirror of
https://gitee.com/milvus-io/milvus.git
synced 2026-01-07 19:31:51 +08:00
[skip ci] contributing&readme_proofread (#4919)
* [skip ci] contributing&readme_proofread Signed-off-by: LocoRichard <lichen.wang@zilliz.com>
This commit is contained in:
LocoRichard
Xiangyu Wang
parent
6b1c09c8c0
commit
3dd4376c8f
@ -1,46 +1,39 @@
|
||||
# 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. :tada:
|
||||
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](https://milvus.io/).
|
||||
|
||||
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.
|
||||
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](CODE_OF_CONDUCT.md).
|
||||
|
||||
## 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), and format your code accordingly.
|
||||
- Run [unit tests](CONTRIBUTING.md#run-unit-test-with-code-coverage) and check your code coverage rate.
|
||||
|
||||
## 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/choose) 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/choose). 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](CONTRIBUTING.md#contributing-code).
|
||||
1. To report a bug or a problem with documentation, please file an [issue](https://github.com/milvus-io/milvus/issues/new/choose) providing the details of the problem. If you believe that 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/choose). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees on the plan, you can follow the [Contributing code](CONTRIBUTING.md#contributing-code) to implement it.
|
||||
3. To implement a feature or bug-fix for an existing outstanding issue, follow the [Contributing code](CONTRIBUTING.md#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, see [GitHub workflow](#github-workflow). Make sure to refer to the related issue in your pull request's comment and update [CHANGELOG.md](CHANGELOG.md).
|
||||
If you have improvements to Milvus, send us your pull requests! For those just getting started, see [GitHub workflow](#github-workflow). Make sure to refer to the related issue in the ccomment of your pull request and update [CHANGELOG.md](CHANGELOG.md).
|
||||
|
||||
The Milvus team members will review your pull requests, and once it is accepted, the status of the projects 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.
|
||||
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.
|
||||
|
||||
### GitHub workflow
|
||||
|
||||
Please create a new branch from an up-to-date master on your fork.
|
||||
Generally, we follow the "fork-and-pull" Git workflow.
|
||||
|
||||
1. Fork the repository on GitHub.
|
||||
1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the repository on GitHub.
|
||||
2. Clone your fork to your local machine with `git clone git@github.com:<yourname>/milvus.git`.
|
||||
3. Create a branch with `git checkout -b my-topic-branch`.
|
||||
4. Make your changes, commit, then push to to GitHub with `git push --set-upstream origin my-topic-branch`. You must record your changes in [CHANGELOG.md](CHANGELOG.md) with issue numbers and descriptions.
|
||||
5. Visit GitHub and make your pull request.
|
||||
4. [Commit](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork) changes to your own branch, then push to to GitHub with `git push --set-upstream origin my-topic-branch`. You must record your changes in [CHANGELOG.md](CHANGELOG.md) with issue numbers and descriptions.
|
||||
5. Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) so that we can review your changes.
|
||||
|
||||
If you have an existing local repository, please update it before you start, to minimize the chance of merge conflicts.
|
||||
Remember to [sync your forked repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced) *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.
|
||||
|
||||
```shell
|
||||
git remote add upstream git@github.com:milvus-io/milvus.git
|
||||
@ -51,7 +44,7 @@ git checkout -b my-topic-branch
|
||||
|
||||
### General guidelines
|
||||
|
||||
Before sending your pull requests for review, make sure your changes are consistent with the guidelines and follow the Milvus coding style.
|
||||
Before submitting your pull requests for review, make sure that your changes are consistent with the [coding style](CONTRIBUTING.md#coding-style), and run [unit tests](CONTRIBUTING.md#run-unit-test-with-code-coverage) to check your code coverage rate.
|
||||
|
||||
- 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.
|
||||
@ -104,7 +97,7 @@ $ make clang-format
|
||||
|
||||
## Run unit test with code coverage
|
||||
|
||||
Before submitting your PR, make sure you have run unit test, and your code coverage rate is >= 90%.
|
||||
Before submitting your Pull Request, make sure you have run unit test, and your code coverage rate is >= 90%.
|
||||
|
||||
Install lcov
|
||||
```shell
|
||||
|
||||
@ -12,7 +12,7 @@
|
||||
|
||||
## What is Milvus
|
||||
|
||||
As an open source vector similarity search engine, Milvus is easy-to-use, highly reliable, scalable, robust, and blazing fast. Adopted by over 100 organizations and institutions worldwide, Milvus empowers applications in a variety of fields, including image processing, computer vision, natural language processing, voice recognition, recommender systems, drug discovery, and more.
|
||||
As an open source vector database, Milvus is easy-to-use, highly reliable, robust, and blazing fast. Adopted by over 600 organizations and institutions worldwide, Milvus empowers applications in a variety of fields, including image processing, computer vision, natural language processing, voice recognition, recommender systems, drug discovery, and more.
|
||||
|
||||
The following is Milvus architecture:
|
||||
|
||||
@ -57,13 +57,13 @@ It is a Work in Progress, and is subject to reasonable adjustments when necessar
|
||||
|
||||
## Contribution guidelines
|
||||
|
||||
Contributions are welcomed and greatly appreciated. Please read our [contribution guidelines](CONTRIBUTING.md) for detailed contribution workflow. This project adheres to the [code of conduct](CODE_OF_CONDUCT.md) of Milvus. You must abide by this code in order to participate.
|
||||
Contributions are welcomed and greatly appreciated. Please read our [contribution guidelines](CONTRIBUTING.md) for detailed contribution workflow. This project adheres to the [code of conduct](CODE_OF_CONDUCT.md) of Milvus. You must abide by this code to participate.
|
||||
|
||||
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 our community
|
||||
|
||||
:heart: To connect with other users and contributors, welcome to join our [Slack channel](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ).
|
||||
:heart: To connect with other users and contributors, you can join our [Slack channel](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ).
|
||||
|
||||
See our [community](https://github.com/milvus-io/community) repository to learn more about our governance and access more community resources.
|
||||
|
||||
|
||||
14
README_CN.md
14
README_CN.md
@ -17,7 +17,7 @@
|
||||
|
||||
## Milvus 是什么
|
||||
|
||||
Milvus 是一款开源的特征向量相似度搜索引擎，具有使用方便、实用可靠、易于扩展、稳定高效和搜索迅速等特点，在全球范围内被上百家组织和机构所采用。Milvus 已经被广泛应用于多个领域，其中包括图像处理、机器视觉、自然语言处理、语音识别、推荐系统以及新药发现等。
|
||||
Milvus 是一款开源的特征向量数据库，具有使用方便、实用可靠、稳定高效和搜索迅速等特点，在全球范围内被六百家余组织和机构所采用。Milvus 已经被广泛应用于多个领域，其中包括图像处理、机器视觉、自然语言处理、语音识别、推荐系统以及新药发现等。
|
||||
|
||||
Milvus 的架构如下：
|
||||
|
||||
@ -25,7 +25,7 @@ Milvus 的架构如下：
|
||||
|
||||
若要了解 Milvus 详细介绍和整体架构，请访问 [Milvus 简介](https://www.milvus.io/docs/overview.md)。你可以通过 [版本发布说明](https://www.milvus.io/docs/release_notes.md) 获取最新版本的功能和更新。
|
||||
|
||||
Milvus是一个 [LF AI & Data 基金会](https://lfaidata.foundation/)的孵化项目。获取更多，请访问[lfai.foundation](https://lfaidata.foundation/)。
|
||||
Milvus 是一个 [LF AI & Data 基金会](https://lfaidata.foundation/) 的孵化项目。获取更多，请访问 [lfai.foundation](https://lfaidata.foundation/)。
|
||||
|
||||
## Milvus 快速上手
|
||||
|
||||
@ -52,17 +52,17 @@ Milvus 可以应用于多种 AI 场景。你可以访问 [Milvus 应用场景](h
|
||||
|
||||
## 性能基准测试
|
||||
|
||||
关于 Milvus 性能基准的更多信息，请参考[测试报告](https://github.com/milvus-io/milvus/tree/master/docs)。
|
||||
关于 Milvus 性能基准的更多信息，请参考 [测试报告](https://github.com/milvus-io/milvus/tree/master/docs)。
|
||||
|
||||
## 路线图
|
||||
|
||||
你可以参考我们的[路线图](https://github.com/milvus-io/milvus/milestones)，了解 Milvus 即将实现的新特性。
|
||||
你可以参考我们的 [路线图](https://github.com/milvus-io/milvus/milestones)，了解 Milvus 即将实现的新特性。
|
||||
|
||||
路线图尚未完成，并且可能会存在合理改动。我们欢迎各种针对路线图的意见、需求和建议。
|
||||
|
||||
## 贡献者指南
|
||||
|
||||
我们由衷欢迎你推送贡献。关于贡献流程的详细信息，请参阅[贡献者指南](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md)。本项目遵循 Milvus [行为准则](https://github.com/milvus-io/milvus/blob/master/CODE_OF_CONDUCT.md)。如果你希望参与本项目，请遵守该准则的内容。
|
||||
我们由衷欢迎你推送贡献。关于贡献流程的详细信息，请参阅 [贡献者指南](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md)。本项目遵循 Milvus [行为准则](https://github.com/milvus-io/milvus/blob/master/CODE_OF_CONDUCT.md)。如果你希望参与本项目，请遵守该准则的内容。
|
||||
|
||||
我们使用 [GitHub issues](https://github.com/milvus-io/milvus/issues) 追踪问题和补丁。若你希望提出问题或进行讨论，请加入我们的社区。
|
||||
|
||||
@ -72,7 +72,7 @@ Milvus 可以应用于多种 AI 场景。你可以访问 [Milvus 应用场景](h
|
||||
|
||||
## 加入 Milvus 技术交流微信群
|
||||
|
||||
|
||||
|
||||
|
||||
## 相关链接
|
||||
|
||||
@ -92,4 +92,4 @@ Milvus 可以应用于多种 AI 场景。你可以访问 [Milvus 应用场景](h
|
||||
|
||||
## 许可协议
|
||||
|
||||
[Apache 许可协议 2.0 版](https://github.com/milvus-io/milvus/blob/master/LICENSE)
|
||||
[Apache 许可协议 2.0 版](LICENSE)
|
||||
Loading…
x
Reference in New Issue
Block a user