From 2b4f71a6d8fbbe8e05dd3f3572061631d1ea693b Mon Sep 17 00:00:00 2001 From: Yang Xuan <xuan.yang@zilliz.com> Date: Mon, 13 Sep 2021 19:44:39 +0800 Subject: [PATCH] [skip-ci]Add table of milvus community projects Signed-off-by: Yang Xuan <xuan.yang@zilliz.com> --- CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5eb46a25c..a7c6fd1cd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,9 +6,17 @@ The following are a set of guidelines for contributing to Milvus. Following thes As for everything else in the project, the contributions to Milvus are governed by our [Code of Conduct](CODE_OF_CONDUCT.md). - ## What contributions can I make? +| Suitable for | Projects | Resources | +| ---------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| Go developers | [milvus](https://github.com/milvus-io/milvus) | | +| CPP developers | [milvus](https://github.com/milvus-io/milvus) | | +| Developers interested in other languages | [pymilvus](https://github.com/milvus-io/pymilvus), [milvus-sdk-go](https://github.com/milvus-io/milvus-sdk-go), [milvus-sdk-node](https://github.com/milvus-io/milvus-sdk-node), [milvus-sdk-java](https://github.com/milvus-io/milvus-sdk-java) | [Contributing to PyMilvus](https://github.com/milvus-io/pymilvus/blob/master/CONTRIBUTING.md) | +| Kubernetes enthusiasts | [milvus-helm](https://github.com/milvus-io/milvus-helm) | | +| Tech writers and docs enthusiasts | [milvus-docs](https://github.com/milvus-io/milvus-docs) | [Contributing to milvus docs](https://github.com/milvus-io/milvus-docs/blob/v2.0.0/CONTRIBUTING.md) | +| Web developers | | | + 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 that the issue needs priority attention, please comment on the issue to notify the team. @@ -30,7 +38,7 @@ Generally, we follow the "fork-and-pull" Git workflow. 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. [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. +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 origin my-topic-branch`. 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. 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.