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

Setting up Git: Update sections per layout style guide #26463

Merged
merged 2 commits into from
Oct 17, 2023

Conversation

matthewsanner
Copy link
Contributor

Because

Update the page as per the Odin Project style guide to improve consistency.

This PR

Step 1: Install Git section

  • Fixed spacing of numbered list items.
  • Added punctuation to list item with verb.

Step 2: Configure Git and GitHub section

  • Replaced * with - for unordered list items.

Additional Resources section

  • Fixed spacing for unordered list items.

Issue

Related to #26437

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@github-actions github-actions bot added the Content: Foundations Involves the Foundations content label Oct 9, 2023
@ManonLef
Copy link
Member

Hi there @matthewsanner and thank you for editing this file. I did notice your formatter edited a lot more in the documents. It changed codeblock formatting from ~~~ to ``` for example. When working on repositories not being your own, it's best not to format automatically since it might not adhere to the style guide.

Could you revert those changes and make sure only the list items are updated please? Thanks in advance.

@matthewsanner
Copy link
Contributor Author

matthewsanner commented Oct 17, 2023

Thanks for your patience @ManonLef, I'm just learning how to make these open-source commits. All auto-format changes have been reverted in my latest commit. I only retained proper changes which were outlined in my original commentary. Let me know if there's anything else!

@ManonLef
Copy link
Member

Anytime @matthewsanner ! Thanks so much for making this change, it's highly appreciated!

@ManonLef ManonLef merged commit f03c616 into TheOdinProject:main Oct 17, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: Foundations Involves the Foundations content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants