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 to make heading and description match #53434

Merged
merged 1 commit into from
May 21, 2024

Conversation

lilin90
Copy link
Member

@lilin90 lilin90 commented May 21, 2024

What problem does this PR solve?

Issue Number: N/A

Problem Summary: Updates one heading in README.md to make the heading and description match. The existing ones don't match. TiDB Developer Guide and TiDB Cloud Developer Guide are for application developers, not for those contributors who would like to contribute to TiDB code. For how to contribute to TiDB, it's described in the Contributing section.

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

@lilin90 lilin90 requested a review from lance6716 May 21, 2024 03:57
@ti-chi-bot ti-chi-bot bot added do-not-merge/needs-linked-issue release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 21, 2024
@lilin90 lilin90 added the skip-issue-check Indicates that a PR no need to check linked issue. label May 21, 2024
@ti-chi-bot ti-chi-bot bot added approved needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels May 21, 2024
Copy link

ti-chi-bot bot commented May 21, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hawkingrei, lance6716

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:
  • OWNERS [hawkingrei,lance6716]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels May 21, 2024
Copy link

ti-chi-bot bot commented May 21, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-05-21 04:33:26.83214208 +0000 UTC m=+2146160.589277646: ☑️ agreed by lance6716.
  • 2024-05-21 05:02:36.51015052 +0000 UTC m=+2147910.267286093: ☑️ agreed by hawkingrei.

@ti-chi-bot ti-chi-bot bot merged commit 35e4c84 into pingcap:master May 21, 2024
4 of 5 checks passed
@lilin90 lilin90 deleted the fix-readme branch May 21, 2024 06:50
@DanRoscigno
Copy link
Contributor

Thanks for fixing that @lilin90 , I saw your note after my PR was merged and went to update it and then saw you changed it.

RidRisR pushed a commit to RidRisR/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 release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. skip-issue-check Indicates that a PR no need to check linked issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants