You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kvrocks.apache.org by tw...@apache.org on 2023/01/22 03:33:53 UTC
[incubator-kvrocks] branch unstable updated: Add contributing section in README (#1231)
This is an automated email from the ASF dual-hosted git repository.
twice pushed a commit to branch unstable
in repository https://gitbox.apache.org/repos/asf/incubator-kvrocks.git
The following commit(s) were added to refs/heads/unstable by this push:
new 0109c721 Add contributing section in README (#1231)
0109c721 is described below
commit 0109c7215462ac8f67055d4834b7b460d442de19
Author: Twice <tw...@gmail.com>
AuthorDate: Sun Jan 22 11:33:47 2023 +0800
Add contributing section in README (#1231)
---
README.md | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 38c2d99b..0e62f316 100644
--- a/README.md
+++ b/README.md
@@ -122,15 +122,12 @@ $ ./x.py test go # run Golang (unit and integration) test cases
### Supported platforms
-* Linux distributions
- * CentOS
- * Ubuntu
- * and most other distros
+* Linux
* macOS
## Namespace
-Namespace is used to isolate data between users. Unlike all the Redis databases can be visited by `requirepass`, we use one token per namespace. `requirepass` is regraded as admin token, and only admin token allows to access the namespace command, as well as some commands like `config`, `slaveof`, `bgsave`, etc..
+Namespace is used to isolate data between users. Unlike all the Redis databases can be visited by `requirepass`, we use one token per namespace. `requirepass` is regraded as admin token, and only admin token allows to access the namespace command, as well as some commands like `config`, `slaveof`, `bgsave`, etc. See the [Namespace](https://kvrocks.apache.org/docs/namespace) page for more details.
```
# add token
@@ -168,8 +165,12 @@ Documents are hosted at the [official website](https://kvrocks.apache.org/docs/g
## Tools
* Export the Kvrocks monitor metrics, please use [kvrocks_exporter](https://github.com/KvrocksLabs/kvrocks_exporter)
-* Migrate from redis to kvrocks, use [redis-migrate-tool](https://github.com/vipshop/redis-migrate-tool) which was developed by @vipshop
-* Migrate from kvrocks to redis. use `kvrocks2redis` in build dir
+* Migrate from redis to kvrocks, use [redis-migrate-tool](https://github.com/vipshop/redis-migrate-tool) which was developed by [vipshop](https://github.com/vipshop)
+* Migrate from kvrocks to redis, use `kvrocks2redis` in the build directory
+
+## Contributing
+
+Kvrocks community welcomes all forms of contribution and you can find out how to get involved on the [Community](https://kvrocks.apache.org/community/) and [How to Contribute](https://kvrocks.apache.org/community/contributing) pages.
## Performance