-
Notifications
You must be signed in to change notification settings - Fork 15k
Replace ex.
in guides with for example
#437
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
Conversation
Also replaced a comma with an or to help improve text flow
Hi @bvhme, thanks for this suggestion! I like this idea, as I think it will make the guides less confusing for non-native English speakers in particular. For readability purposes, could you add a comma after every
Thanks! |
Yes, I've done it. Please check whether this is the consistency you were thinking of, after some Googling I found out that the comma should be there in case of a list, so I've added it where there were multiples. |
Can this be merged? |
@bvhme I think it reads better with a comma after every "for example", and Googling around, it seems there isn't a hard rule to follow. "for example passwords or other non-public information" seems to be missed even following list rule. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of commas left then should be good to go!
_articles/en-US/best-practices.md
Outdated
* The types of contributions you'll accept (_Do you only want help with a certain part of your code?_) | ||
* When it's appropriate to follow up (_ex. "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_) | ||
* How much time you spend on the project (_ex. "We only spend about 5 hours per week on this project"_) | ||
* When it's appropriate to follow up (_for example "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a comma
_articles/en-US/best-practices.md
Outdated
* When it's appropriate to follow up (_ex. "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_) | ||
* How much time you spend on the project (_ex. "We only spend about 5 hours per week on this project"_) | ||
* When it's appropriate to follow up (_for example "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_) | ||
* How much time you spend on the project (_for example "We only spend about 5 hours per week on this project"_) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a comma
_articles/en-US/how-to-contribute.md
Outdated
* **[Fork the repository](https://guides.github.com/activities/forking/)** and clone it locally. Connect your local to the original "upstream" repository by adding it as a remote. Pull in changes from "upstream" often so that you stay up to date so that when you submit your pull request, merge conflicts will be less likely. (See more detailed instructions [here](https://help.github.com/articles/syncing-a-fork/).) | ||
* **[Create a branch](https://guides.github.com/introduction/flow/)** for your edits. | ||
* **Reference any relevant issues** or supporting documentation in your PR (ex. "Closes #37.") | ||
* **Reference any relevant issues** or supporting documentation in your PR (for example "Closes #37.") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a comma
* [Thin](https://github.com/macournoyer/thin) is a fast and simple Ruby web server | ||
|
||
If you're building upon an existing project, using their name as a prefix can help clarify what your project does (ex. [node-fetch](https://github.com/bitinn/node-fetch) brings `window.fetch` to Node.js). | ||
If you're building upon an existing project, using their name as a prefix can help clarify what your project does (for example [node-fetch](https://github.com/bitinn/node-fetch) brings `window.fetch` to Node.js). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a comma
<input type="checkbox" id="cbox7" class="d-block float-left mt-1 mr-2" value="checkbox"> | ||
<label for="cbox7" class="overflow-hidden d-block text-normal"> | ||
There are no sensitive materials in the revision history, issues, or pull requests (ex. passwords or other non-public information) | ||
There are no sensitive materials in the revision history, issues, or pull requests (for example passwords or other non-public information) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a comma
Done, and done! |
Thanks for your first contribution to Open Source Guides, @bvhme! Without people like you submitting PRs we couldn't run this project. You rock! |
Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.
I was reading the guides using my screen reader and was perplexed when I heard 'ex-community'. After inspecting the letters I found the usage of a non-standard abbreviation for example with
ex
.I personally feel writing out
for example
is a lot clearer thanex.
.Thanks so much, love the guides!