guettli / programming-guidelines

My personal programming guidelines
298 stars 43 forks source link

Fix grammatical mistakes and typos found in README.md #9

Closed emmysteven closed 3 years ago

emmysteven commented 3 years ago

Hello! 👋🏻 I wanted to discuss this before opening a pull request.

Your guideline has help me tremendously and want to say a big thank for sharing this information free of charge. However I found some grammatical mistakes and typos on some segments, and I would love to point out a few with their corresponding corrections.

purpuse this typo can be found under this heading make-a-clear-distinction-between-authentication-and-permission-checks

-- purpuse
++ purpose

immideately this typo can be found under this heading FTUE

-- immideately
++ immediately 

Idempotence is great, since it ensures, that it does not do harm if the method is called twice. this issue is found under this segment idempotence-is-great

-- Idempotence is great, since it ensures, that it does not do harm if the method is called twice.
++ Idempotence is great, since it ensures that no harm is done if the method is called twice.

These are the ones I could spot out for now. Do I have the permission to effect these corrections and many others and then create a pull request? 🙏

guettli commented 3 years ago

@emmysteven thank you very much for your input. This motivated my to do something which I have planed since several month: I checked the whole text with Grammarly. Could you please have a look again at the text. I think I changed about 600 mistakes which Grammarly detected.

guettli commented 3 years ago

If you find a mistake, please create a pull request. Thank you!

And if you like it, then please share it!

emmysteven commented 3 years ago

Thank you for your response

I'll do as you have said, If I find any mistake, I'll create a pull request.

Cheers!