-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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.
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
docs: update README.md #53373
docs: update README.md #53373
Conversation
Some grammar edits
Welcome @DanRoscigno! |
Hi @DanRoscigno. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Hi @DanRoscigno. Thanks for your PR. PRs from untrusted users cannot be marked as trusted with I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@lilin90: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
README.md
Outdated
|
||
### Start with TiDB | ||
|
||
See [TiDB Quick Start Guide](https://docs.pingcap.com/tidb/stable/quick-start-with-tidb). | ||
|
||
### Start developing TiDB | ||
### Start developing with TiDB |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we mean "contribute to tidb's codebase" rather than "use tidb to develop your own project"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the sentence we put in line 72, it should be "Start developing TiDB" here. Perhaps we should update the description in line 72. For contributing to TiDB's code, it's also covered in the following "Contributing" section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it to this:
### Contributing to TiDB development
I think this is the clearest way to write this.
/ok-to-test |
LGTM Co-authored-by: Lilian Lee <[email protected]>
README.md
Outdated
|
||
### Start with TiDB | ||
|
||
See [TiDB Quick Start Guide](https://docs.pingcap.com/tidb/stable/quick-start-with-tidb). | ||
|
||
### Start developing TiDB | ||
### Start developing with TiDB |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### Start developing with TiDB | |
### Contributing to TiDB development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DanRoscigno I see that you accepted my suggestion via edcfa38. IMO, with this suggestion, this title "Start developing with TiDB" is more appropriate.
@DanRoscigno: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lance6716, lilin90, ngaut The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Some grammar edits
What problem does this PR solve?
Issue Number: close #53372
Problem Summary:
What changed and how does it work?
Check List
Tests
Side effects
Documentation
Release note
Please refer to Release Notes Language Style Guide to write a quality release note.