Skip to content

[Doc-17209]Fix typos and improve grammar in README.md #17206

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
Merged
SbloodyS merged 2 commits into from
May 27, 2025
Merged

[Doc-17209]Fix typos and improve grammar in README.md #17206

SbloodyS merged 2 commits into from
May 27, 2025

Conversation

@Rockefeller04
Copy link
Contributor

@Rockefeller04 Rockefeller04 commented May 25, 2025 •
edited by Gallardot
Loading

Purpose of the pull request

Fix grammatical errors and improve sentence structure in README documentation.

Brief change log

  • ​Verb tense correction: Change "is also provided" to "also provided" in project description
  • ​Subject-verb agreement: Change "which including" to "which includes" in deployment methods list
  • ​Preposition adjustment: Change "by four ways" to "in four ways" in usage methods list
  • ​Sentence structure optimization: Remove redundant "which" in feature descriptions

Verify this pull request

This pull request is code cleanup without any test coverage.

@boring-cyborg
Copy link

boring-cyborg bot commented May 25, 2025

Thanks for opening this pull request! Please check out our contributing guidelines. (https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/contribute/join/pull-request.md)

@Rockefeller04 Rockefeller04 marked this pull request as draft May 26, 2025 01:50
@Rockefeller04 Rockefeller04 changed the title docs: Fix typos and improve grammar in README.md [Chore][doc] Fix typos and improve grammar in README.md May 26, 2025
@Rockefeller04 Rockefeller04 marked this pull request as ready for review May 26, 2025 01:52
@Rockefeller04 Rockefeller04 marked this pull request as draft May 26, 2025 01:56
@Rockefeller04 Rockefeller04 marked this pull request as ready for review May 26, 2025 02:01
@Rockefeller04
Copy link
Contributor Author

Rockefeller04 commented May 26, 2025

@Gallardot 您有空的时候可以帮忙看看吗

@SbloodyS
Copy link
Member

SbloodyS commented May 26, 2025

Thanks for opening this pull request! Please check out our contributing guidelines. (https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/contribute/join/pull-request.md)

This is not a chore. Please follow the pull request notice and create a improment issue first. @Rockefeller04

@Rockefeller04
Copy link
Contributor Author

Rockefeller04 commented May 26, 2025

收到

@Rockefeller04 Rockefeller04 marked this pull request as draft May 26, 2025 02:34
@Rockefeller04 Rockefeller04 changed the title [Chore][doc] Fix typos and improve grammar in README.md [Chore-17209][doc] Fix typos and improve grammar in README.md May 26, 2025
@Rockefeller04 Rockefeller04 marked this pull request as ready for review May 26, 2025 02:36
@Rockefeller04
Copy link
Contributor Author

Rockefeller04 commented May 26, 2025

@SbloodyS I've made revisions based on my understanding of the documentation. Could you please review my PR to see if there are any remaining issues?

@Gallardot Gallardot changed the title [Chore-17209][doc] Fix typos and improve grammar in README.md [Doc-17209]Fix typos and improve grammar in README.md May 26, 2025
@Gallardot Gallardot added this to the 3.3.1 milestone May 26, 2025
Gallardot
Gallardot approved these changes May 26, 2025
View reviewed changes
Copy link
Member

@Gallardot Gallardot left a comment

Choose a reason for hiding this comment

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

LGTM

@Rockefeller04 Rockefeller04 requested a review from Gallardot May 27, 2025 00:02
@Rockefeller04
Copy link
Contributor Author

Rockefeller04 commented May 27, 2025

so sorry:( ,it seems like I clicked the wrong button(review twice),but hope this pr can be taken a look by the second reviewer:)

@SbloodyS SbloodyS added first time contributor First-time contributor improvement make more easy to user or prompt friendly and removed 3.3.0 labels May 27, 2025
@sonarqubecloud
Copy link

sonarqubecloud bot commented May 27, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

SbloodyS
SbloodyS approved these changes May 27, 2025
View reviewed changes
Copy link
Member

@SbloodyS SbloodyS left a comment

Choose a reason for hiding this comment

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

+1

@SbloodyS SbloodyS merged commit 943a32f into apache:dev May 27, 2025
73 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented May 27, 2025

Awesome work, congrats on your first merged pull request!

@Rockefeller04 Rockefeller04 deleted the docs/fix-readme-typo branch May 27, 2025 12:38
@codeOwlAI codeOwlAI mentioned this pull request Jun 30, 2025
Open
davidzollo pushed a commit to davidzollo/dolphinscheduler that referenced this pull request Oct 27, 2025
@Rockefeller04 @davidzollo
[Doc-17209]Fix typos and improve grammar in README.md (apache#17206)
c28670b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SbloodyS SbloodyS SbloodyS approved these changes

@Gallardot Gallardot Awaiting requested review from Gallardot

Assignees

@Rockefeller04 Rockefeller04

Labels

document first time contributor First-time contributor improvement make more easy to user or prompt friendly

Projects

None yet

Milestone

3.3.1

Development

Successfully merging this pull request may close these issues.

[Doc][doc] Documentation bug and improvement

3 participants

@Rockefeller04 @SbloodyS @Gallardot