Skip to content

Conversation

bvhme
Copy link
Contributor

@bvhme bvhme commented Aug 18, 2017

  • Have you followed the contributing guidelines?
  • Have you explained what your changes do, and why they add value to the Guides?

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 than ex..

Thanks so much, love the guides!

@nayafia
Copy link
Contributor

nayafia commented Aug 19, 2017

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 for example?

for example, "We only spend about 5 hours per week on this project"

Thanks!

@bvhme
Copy link
Contributor Author

bvhme commented Aug 20, 2017

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.

@bvhme
Copy link
Contributor Author

bvhme commented Oct 10, 2017

Can this be merged?

@mlinksva
Copy link
Contributor

@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.

Copy link
Contributor

@MikeMcQuaid MikeMcQuaid left a 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!

* 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."_)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a comma

* 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"_)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a comma

* **[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.")
Copy link
Contributor

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).
Copy link
Contributor

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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a comma

@bvhme
Copy link
Contributor Author

bvhme commented Oct 20, 2017

Done, and done!

@MikeMcQuaid
Copy link
Contributor

Thanks for your first contribution to Open Source Guides, @bvhme! Without people like you submitting PRs we couldn't run this project. You rock!

@MikeMcQuaid MikeMcQuaid merged commit d5696de into github:gh-pages Oct 20, 2017
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.

6 participants