Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revise CONTRIBUTING.md contents #14032

Merged
merged 5 commits into from
Feb 16, 2023
Merged

Revise CONTRIBUTING.md contents #14032

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
952f0be
Revise CONTRIBUTING.md contents
woofyzhao Jan 10, 2023
5efd8cd
Revise CONTRIBUTING.md contents
woofyzhao Jan 10, 2023
f4ed610
Merge branch 'master' into TIKV-14031
woofyzhao Jan 11, 2023
c064693
Merge branch 'master' into TIKV-14031
woofyzhao Feb 15, 2023
11b575b
Merge branch 'master' into TIKV-14031
ti-chi-bot Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ To build TiKV you'll need to at least have the following installed:
* `make` - Build tool (run common workflows)
* `cmake` - Build tool (required for gRPC)
* `awk` - Pattern scanning/processing language
* [`protoc`](https://github.com/protocolbuffers/protobuf/releases) - Google protocol buffer compiler
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have drop the dependency long time ago, I believe it's introduced back because of etcd-client. /cc @YuJuncen

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, more preciously it is prost that brings this requirement. After PD exposing some of the operations over the etcd key space in pdpb, I guess we would be able to remove the requirement of etcd soon.

* C++ compiler - gcc 5+ (required for gRPC)

If you are targeting platforms other than x86_64/aarch64 Linux or macOS, you'll also need:
Expand Down Expand Up @@ -92,7 +93,7 @@ make format
make clippy
```

See the [style doc](https://github.com/rust-lang/rfcs/blob/master/style-guide/README.md) and the [API guidelines](https://rust-lang-nursery.github.io/api-guidelines/) for details on the conventions.
See the [style doc](https://github.com/rust-lang/fmt-rfcs/blob/master/guide/guide.md) and the [API guidelines](https://rust-lang-nursery.github.io/api-guidelines/) for details on the conventions.

Please follow this style to make TiKV easy to review, maintain, and develop.

Expand All @@ -115,13 +116,13 @@ To run TiKV as an actual key-value store, you will need to run it as a cluster (

Use [PD](https://github.com/tikv/pd) to manage the cluster (even if just one node on a single machine).

Instructions are in our [docs](https://tikv.org/docs/dev/tasks/deploy/binary/) (if you build TiKV from source, you could skip `1. Download package` and `tikv-server` is in directory `/target`).
Instructions are in our [docs](https://tikv.org/docs/latest/deploy/install/test/#install-binary-manually) (if you build TiKV from source, you could skip `1. Download package` and `tikv-server` is in directory `/target`).

Tips: It's recommended to increase the open file limit above 82920. WSL2 users may refer to [the comment](https://github.com/Microsoft/WSL/issues/1688#issuecomment-532767317) if having difficulty in changing the `ulimit`.

### Configuration

Read our configuration guide to learn about various [configuration options](https://tikv.org/docs/dev/tasks/configure/introduction/). There is also a [configuration template](./etc/config-template.toml).
Read our configuration guide to learn about various [configuration options](https://tikv.org/docs/latest/deploy/configure/introduction/). There is also a [configuration template](./etc/config-template.toml).

## Contribution flow

Expand All @@ -133,7 +134,7 @@ This is a rough outline of what a contributor's workflow looks like:
- Write code, add test cases, and commit your work (see below for message format).
- Run tests and make sure all tests pass.
- Push your changes to a branch in your fork of the repository and submit a pull request.
* Make sure mention the issue, which is created at step 1, in the commit meesage.
* Make sure to mention the issue, which is created at step 1, in the commit message.
- Your PR will be reviewed and may be requested some changes.
* Once you've made changes, your PR must be re-reviewed and approved.
* If the PR becomes out of date, you can use GitHub's 'update branch' button.
Expand Down