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.

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

Merged
merged 3 commits into from
May 20, 2024
Merged

docs: update README.md #53373

merged 3 commits into from
May 20, 2024

Conversation

DanRoscigno
Copy link
Contributor

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

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No need to test
    • I checked and no code files have been changed.

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

Some grammar edits
@sre-bot
Copy link
Contributor

sre-bot commented May 19, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

ti-chi-bot bot commented May 19, 2024

Welcome @DanRoscigno!

It looks like this is your first PR to pingcap/tidb 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/tidb. 😃

@ti-chi-bot ti-chi-bot bot added needs-ok-to-test size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 19, 2024
Copy link

ti-chi-bot bot commented May 19, 2024

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

Copy link

tiprow bot commented May 19, 2024

Hi @DanRoscigno. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

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.

Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

ti-chi-bot bot commented May 19, 2024

@lilin90: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM

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
Copy link
Contributor

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"

Copy link
Member

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.

Copy link
Contributor Author

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.

@hawkingrei hawkingrei changed the title Update README.md docs: Update README.md May 19, 2024
@hawkingrei
Copy link
Member

/ok-to-test

@lilin90 lilin90 changed the title docs: Update README.md docs: update README.md May 20, 2024
README.md Outdated Show resolved Hide resolved
LGTM

Co-authored-by: Lilian Lee <lilin@pingcap.com>
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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
### Start developing with TiDB
### Contributing to TiDB development

Copy link
Member

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.

Copy link

tiprow bot commented May 20, 2024

@DanRoscigno: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
fast_test_tiprow fec7bdd link true /test fast_test_tiprow

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.

Copy link

ti-chi-bot bot commented May 20, 2024

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

ti-chi-bot bot commented May 20, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-05-19 16:10:27.467511714 +0000 UTC m=+2015181.224647287: ☑️ agreed by ngaut.
  • 2024-05-20 14:19:35.230881304 +0000 UTC m=+2094928.988016877: ☑️ agreed by lance6716.

@ti-chi-bot ti-chi-bot bot merged commit 2c76b1a into pingcap:master May 20, 2024
3 of 5 checks passed
terry1purcell pushed a commit to terry1purcell/tidb that referenced this pull request May 20, 2024
RidRisR pushed a commit to RidRisR/tidb that referenced this pull request May 23, 2024
terry1purcell pushed a commit to terry1purcell/tidb that referenced this pull request May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm ok-to-test release-note-none size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README has some grammar problems
6 participants