Skip to content

Improve grammar and .gitignore #318

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

Merged
merged 3 commits into from
Jun 22, 2025
Merged

Improve grammar and .gitignore #318

merged 3 commits into from
Jun 22, 2025

Conversation

CollieIsCute
Copy link
Contributor

@CollieIsCute CollieIsCute commented May 6, 2025

  • Add more contents that cursor IDE generates to .gitignore
  • According to the Legal writing advice, the "or" word already means "X or Y or both", so we don't need to write "and" again.
  • According to merriam-webster dictionary, "Failing that" is a formal idiom, so I correct "Failing this" with that.
  • Add some punctuation:
    • Add double quotes to make sentences more clear
    • Add comma before "for example" because of this page
  • Use more formal word "nonzero" instead. merriam-webster dictionary lists nonzero as the correct form.
  • Add missing be verbs, spaces
  • According to collinsdictionary, "management" is an uncountable noun.

Summary by Bito

This pull request enhances documentation by correcting grammatical errors and improving punctuation in 'lkmpg.tex' and 'examples/hello-1.c'. It employs more formal language and adds necessary punctuation to improve clarity and professionalism.

Copy link
Contributor

@jserv jserv left a comment

Choose a reason for hiding this comment

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

Use git rebase -i to rework commits. Fewer commits are better for review.

@CollieIsCute CollieIsCute force-pushed the master branch 2 times, most recently from 7472995 to 5e391e9 Compare May 9, 2025 18:17
@CollieIsCute
Copy link
Contributor Author

Done.
I've squash all the modification into one commit.

@jserv
Copy link
Contributor

jserv commented May 9, 2025

Done. I've squash all the modification into one commit.

Don't do that. You should preserve 4 commits:

  • Update .gitignore
  • Fix grammar mistakes
  • Fix typo
  • Refine the writing

@jserv
Copy link
Contributor

jserv commented Jun 18, 2025

@CollieIsCute, can you rework?

@sysprog21 sysprog21 deleted a comment from CollieIsCute Jun 18, 2025
@CollieIsCute
Copy link
Contributor Author

@jserv Yes I do!
I'll fix it this week.

@CollieIsCute
Copy link
Contributor Author

Maybe three kinds of commits are enough, so I just merge them into 3.

@CollieIsCute CollieIsCute requested a review from jserv June 22, 2025 22:30
@jserv jserv merged commit 687ce7c into sysprog21:master Jun 22, 2025
1 check passed
@jserv
Copy link
Contributor

jserv commented Jun 22, 2025

Thank @CollieIsCute for contributing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants