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

Fixes spelling and grammar errors #4168

Merged
merged 3 commits into from
Jan 4, 2024
Merged

Conversation

H4ppy-04
Copy link
Contributor

@H4ppy-04 H4ppy-04 commented Jul 25, 2023

PR Prelude

Thank you for working on YCM! :)

Please complete these steps and check these boxes (by putting an x inside
the brackets) before filing your PR:

  • I have read and understood YCM's CONTRIBUTING document.
  • I have read and understood YCM's CODE_OF_CONDUCT document.
  • I have included tests for the changes in my PR. If not, I have included a
    rationale for why I haven't.
  • I understand my PR may be closed if it becomes obvious I didn't
    perform all of these steps.

Why this change is necessary and useful

[Please explain in detail why the changes in this PR are needed.]

Tests were not included. Tests weren't included for this pull request because no changes to the source code were made. The only modifications were applied to the README file.

This pull request addresses the issue of grammar inconsistencies and errors present in the README file. By meticulously reviewing and correcting these linguistic flaws, this update significantly enhances the clarity, professionalism, and overall quality of the project's documentation.

The importance of impeccable grammar in a README file cannot be understated. A well-written README not only provides vital information about the project but also reflects the competence and attention to detail of the developers behind it. A poorly written README can lead to confusion, and misunderstanding, and even deter potential contributors and users.

With this pull request, the following improvements have been implemented:

Consistent Tense and Voice: The entire README has been revised to ensure that the tense and voice used throughout the document remain consistent, making it easier for readers to follow the project's narrative.

Proper Punctuation and Capitalization: Punctuation marks, capital letters, and other grammatical elements have been reviewed and fixed, creating a more polished and professional appearance for the README.

Clear and Concise Language: Ambiguous phrasings have been rephrased to deliver information more clearly and concisely, ensuring that users understand the project's purpose and usage effectively.

Fixing Spelling and Typos: Any spelling mistakes and typographical errors that could hinder comprehension have been identified and corrected, guaranteeing a seamless reading experience.

Formatting Consistency: The pull request ensures consistent formatting throughout the README file, resulting in visually appealing and easy-to-navigate documentation.

Inclusive Language: Where applicable, inclusive language has been incorporated to make the README more welcoming and inclusive to all potential users.

By addressing these grammar issues, we elevate the project's credibility and demonstrate a commitment to maintaining high standards for our codebase and documentation. This PR contributes to the project's success by presenting a cohesive and error-free README that fosters positive user experiences and encourages collaboration from the open-source community.

Our goal is to make the project accessible to as many users as possible, and this pull request aligns with that vision by providing a polished and comprehensible README. We believe these improvements will greatly benefit the project, attract more contributors, and ultimately lead to broader adoption.

Thank you for considering this pull request, and we look forward to your feedback and the opportunity to further improve the project's documentation.


This change is Reviewable

* Fixes spelling errors
* Fixes grammar errors
@puremourning
Copy link
Member

Was this done manually?

@H4ppy-04
Copy link
Contributor Author

Was this done manually?

This was done mostly with a markdown spell checker. so sort of.

@puremourning
Copy link
Member

Ok thanks for doing this. Will take me some time to review as it's a lot of changes, some of which subjective. But truly, thanks for taking the time.

@H4ppy-04
Copy link
Contributor Author

Ok thanks for doing this. Will take me some time to review as it's a lot of changes, some of which are subjective. But truly, thanks for taking the time.

Not at all, it's my pleasure to contribute. It's evident that you work hard as a maintainer so it's the least that I can do.

Copy link
Member

@puremourning puremourning left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: 0 of 2 LGTMs obtained (waiting on @Trivoz)

Copy link
Member

@puremourning puremourning left a comment

Choose a reason for hiding this comment

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

:lgtm:

I sampled the changes and they seem sensible. Thanks again.

Reviewable status: 1 of 2 LGTMs obtained (waiting on @Trivoz)

Copy link
Member

@puremourning puremourning left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @Trivoz)

@puremourning
Copy link
Member

@Mergifyio rebase

Copy link
Contributor

mergify bot commented Jan 2, 2024

rebase

❌ Base branch update has failed

Git reported the following error:

Rebasing (1/1)
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
error: could not apply ff4ce17... Fixes spelling and grammar errors
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
Could not apply ff4ce17... Fixes spelling and grammar errors

Copy link

codecov bot commented Jan 2, 2024

Codecov Report

Merging #4168 (2d84788) into master (71166ea) will decrease coverage by 11.31%.
The diff coverage is n/a.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #4168       +/-   ##
===========================================
- Coverage   89.70%   78.40%   -11.31%     
===========================================
  Files          34       29        -5     
  Lines        4420     2755     -1665     
===========================================
- Hits         3965     2160     -1805     
- Misses        455      595      +140     

Copy link
Contributor Author

@H4ppy-04 H4ppy-04 left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: 0 of 2 LGTMs obtained (and 1 stale) (waiting on @Trivoz)

@puremourning puremourning added the Ship It! Manual override to merge a PR by maintainer label Jan 4, 2024
Copy link
Member

@puremourning puremourning left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewable status: 1 of 2 LGTMs obtained (waiting on @Trivoz)

Copy link
Contributor

mergify bot commented Jan 4, 2024

Thanks for sending a PR!

@mergify mergify bot merged commit f94f8eb into ycm-core:master Jan 4, 2024
10 of 13 checks passed
Copy link
Contributor

mergify bot commented Jan 4, 2024

Thanks for sending a PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ship It! Manual override to merge a PR by maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants