search

githubtraining / ci-circle

Course repo for Learning Lab course "Continuous Integration with CircleCI". Template repo ➡
https://github.com/githubtraining/ci-circle-template
Creative Commons Attribution 4.0 International
3 stars 9 forks source link

Sentence case bullet points in README #115

Closed brianamarie closed 5 years ago

brianamarie commented 5 years ago

This pull request sentence cases the bullet points in the description (README) of this course.

cc @githubtraining/learning-engineering @githubtraining/trainers

beardofedu commented 5 years ago

Just copy / pasta from the other PR in the Travis course:

@brianamarie , If I'm not mistaken, a list that completes a leading sentence, does not require and / or should not use capital letters for each bullet. In this example, After you complete this course, you will be able to: [Insert list item]. That being said, the list should use lowercase letters, but use punctuation aka commas at the end of each bulleted item.

References: https://getitwriteonline.com/articles/vertical-lists/

brianamarie commented 5 years ago

@beardofedu Cross posting from https://github.com/githubtraining/release-workflow/pull/115/files#r282360249 for discoverability:

@beardofedu I see what you mean - good catch. After a bit of investigating, (https://github.com/github/manual-of-style/issues/128) it looks like the royal "we" of GitHub follows this style guide. It has the following on lists:

Lists Use numbered lists if sequence is important, for example: instructional steps or top 10 lists. Use bulleted lists if sequence isn’t important. Use parallel construction and try to keep a consistent character length for list items. Introduce the list with a sentence ending in a colon or in a sentence fragment. Capitalize the first letter of each list item. If one or more list items contain a complete sentence, use a period after each list item, even if some are not complete sentences. If no list items contain a complete sentence, don’t use punctuation in the list.

brianamarie commented 5 years ago

I'm going to go ahead and 🚢 this, and we can circle back if we need to. @beardofedu if we should be doing this differently, would you please open an issue in learning-engineering so we can make an organized effort of updating all of the courses?