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

Refine ReadMe.md file. Edit language and formatting (English). #38

Closed
bj-rutledge opened this issue Sep 28, 2023 · 3 comments
Closed

Refine ReadMe.md file. Edit language and formatting (English). #38

bj-rutledge opened this issue Sep 28, 2023 · 3 comments
Assignees

Comments

@bj-rutledge
Copy link
Contributor

Though I have not yet seen any blatant errors in the readme file, I would like to propose some minor changes to the formatting and language. For example, in the Introduction section, the book title is referenced. The title should be in italics (note: this is not a personal gripe but proper English formatting). Next, I would like to go through the file and evaluate the grammar and language used.

I'd be happy to take this on under the Hactoberfest tag!

@sumn2u
Copy link
Owner

sumn2u commented Sep 28, 2023

Thanks for the initiative. 🙏

@bj-rutledge
Copy link
Contributor Author

Great! I have forked the repo. I will review the material more thoroughly and create branches for edits I feel will enhance the reader's experience. I'll likely have a PR on or after October 1st. Thanks for opening this up! It will be fun!

Please let me know if you have any conventions you will want to hold to throughout the book (coding conventions, names for things, etc.).

Finally, please know that I will never be offended if my PR is not accepted, especially on something like this, where it's a bit more subjective rather than objective. 😉

@bj-rutledge
Copy link
Contributor Author

I submitted a PR for a small edit. This is my first time contributing to someone else's project, so I wanted my first PR to be a small change to get the flow with low stakes.

@sumn2u sumn2u closed this as completed Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants