Active voice and typos#295
Conversation
doronkatz
requested review from
NewMexicoKid,
cewilliams,
lenucksi and
spier
as code owners
NewMexicoKid
left a comment
NewMexicoKid
left a comment
There was a problem hiding this comment.
Overall looks okay; found one typo (patter instead of pattern) in an edit. This should be fixed; after, the changes can be merged. Thanks for the attention to detail.
Fix lint-reported issue Fixed typo with patter(n) Fix lint-reported issue
|
Thanks ive made the fixes hopefully (and rebased) |
|
Hi @doronkatz. Thanks for this fantastic contribute. I especially love what you did with the changes from passive to active voice in the Introduction to the book. Helps me a lot as a non-native English speaker :) About the spelling of Open Source, open source, open-source ... So far we mostly use "Open Source", and "open source". When reviewing new patterns, I have kept it this way, due to these two resources where they use the same spelling: Could you explain more about why you would opt to change the spelling to open-source? If we would change this now, I think we might find even more places where this is spelled without a hyphen, at least when we include the form with capital letters as well. Before moving ahead I would want to understand this area in more detail, so that we can make a consistent decision for all patterns and content in this repo. If these contemplations about the open source spelling take too long, I would also be happy to get just the changes to Introduction merged via a separate PR. Thanks again for taking the time to review the content so thoroughly. We appreciate any help we can get on the patterns and the book. |
spier
left a comment
spier
left a comment
There was a problem hiding this comment.
Left a comment on the PR with some thoughts about the "open source" spelling. Also one tiny question inline.
spier
added
📖 Type - Content Work
|
No worries. I was a technical writer in the past and at amazon everything Is about technical writing.
As for open source, I follow the Merriam Webster spelling (https://www.merriam-webster.com/dictionary/open-source) however you are right I have seen it spelt the other way too. Happy to pull that out of the PR rather than break everything.
This email and any attachments are confidential and may be subject to copyright, legal or some other professional privilege.
They are intended solely for the attention and use of the named addressee(s). They may only be copied, distributed or
disclosed with the consent of the copyright owner. If you have received this email by mistake or by breach of the confidentiality
clause, please notify the sender immediately by return email and delete or destroy all copies of the email. Any confidentiality,
privilege or copyright is not waived or lost because this email has been sent to you by mistake.
|
|
Yeah, let's go with that approach then. Thanks again! |
I've found two sources (https://www.computerhope.com/jargon/o/opensour.htm and https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/o/open-source) that talk about using "open-source" when using it as an adjective and "open source" when using it as a noun. So your proposed changes looked okay to me... |
|
Oh good find. I’ll go through the changes tonight and make sure I’m good on my end and re-request.
This email and any attachments are confidential and may be subject to copyright, legal or some other professional privilege.
They are intended solely for the attention and use of the named addressee(s). They may only be copied, distributed or
disclosed with the consent of the copyright owner. If you have received this email by mistake or by breach of the confidentiality
clause, please notify the sender immediately by return email and delete or destroy all copies of the email. Any confidentiality,
privilege or copyright is not waived or lost because this email has been sent to you by mistake.
|
|
@doronkatz is this already the version that you would like to get reviewed and merged? Did you and Tim agree on the route "open-source" (when adjective) and "open source" (when noun)? While I expect that there are more instances outside of the 15 files in this PR that would have to get fixed, I am happy to get this PR merged, given that the changes to the Open Source spelling are consistent within this PR itself. |
Not sure we are fully aligned but for the benefit of this PR, how about I take out the open source changes and merge and we can have a separate PR for that? |
Co-authored-by: Sebastian Spier <github@spier.hu>
doronkatz
force-pushed
the
active_voice_and_typos
branch
from
fccf8ea to
d3266af
Compare
|
The greatly improved intro the book is now live at: Thank you so much @doronkatz! And if you still want to help us get the Open-Source-Spelling improved, we would greatly appreciate your help in a new PR. I for one would certainly benefit from that help as a non-native English speaker :) |
|
Will be helping with the rest of the book as I read snd ingest the other patterns. I am looking to apply this at scale at the big A.
This email and any attachments are confidential and may be subject to copyright, legal or some other professional privilege.
They are intended solely for the attention and use of the named addressee(s). They may only be copied, distributed or
disclosed with the consent of the copyright owner. If you have received this email by mistake or by breach of the confidentiality
clause, please notify the sender immediately by return email and delete or destroy all copies of the email. Any confidentiality,
privilege or copyright is not waived or lost because this email has been sent to you by mistake.
|
|
Nice! If you haven't found it yet, there is also the InnerSource Commons Slack where you can talk to other InnerSource practitioners. Would be great to see you there :) |
3 participants
Reviewed the
introduction.mdas part of my review, and corrected typos, passive voice usage, and grammatical errors.