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

Issue #464 Review & Improve our documentation for first-time contributors- Proofread the README.md file #472

Merged
merged 16 commits into from
Oct 19, 2022

Conversation

EliRen7
Copy link
Contributor

@EliRen7 EliRen7 commented Oct 18, 2022

Hello,

I created a PR for the (Review & Improve our documentation for first-time contributors #464) issue. I improved the readability of the README file by proofreading the document/fixing grammar errors (run on sentences/wording/punctuation). I hope that this helps!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@spier
Copy link
Member

spier commented Oct 19, 2022

Hi @EliRen7 and thank you for your contribution. This certainly helps!

I had to revert your fixes to the summaries (Patlets) of the patterns listed in the README, as those Patlets are copied over from the patterns itself. So changing the Patlets in the overview (README.md) would mean that we have to change them in all patterns as well. That would have been more work than what is feasible pas part of this PR.

I will review the rest of your PR a 2nd time, and then get this merged shortly. Thanks again!

README.md Outdated Show resolved Hide resolved
@spier spier merged commit 4eb7a91 into InnerSourceCommons:main Oct 19, 2022
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