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

Update setting_up_git.md #28251

Merged
merged 7 commits into from
Jun 22, 2024
Merged

Update setting_up_git.md #28251

merged 7 commits into from
Jun 22, 2024

Conversation

theSamyak
Copy link
Contributor

issue #28215
In the "Setting Up Git" lesson (setting_up_git.md), added a note section to clearly differentiate macOS-specific commands from general setup instructions.

Because

Added a note section in the "Setting Up Git" lesson to clearly differentiate macOS-specific commands from general setup instructions.

This PR

Added a note section in setting_up_git.md to highlight macOS-specific commands and also changed the title "macOS Users" to "For macOS Users" improving clarity for users.

Issue

Closes #28215

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum 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

issue TheOdinProject#28215
In the "Setting Up Git" lesson (setting_up_git.md), added a note section to clearly differentiate macOS-specific commands from general setup instructions.
@github-actions github-actions bot added the Content: Foundations Involves the Foundations content label Jun 20, 2024
Copy link
Member

@xandora xandora left a comment

Choose a reason for hiding this comment

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

We have specific styling code for these types of note blocks. Just using > is not the right way to do it in this situation.

Please review the style guide and update this PR accordingly before we can consider merging it.

https://github.com/TheOdinProject/curriculum/blob/main/LAYOUT_STYLE_GUIDE.md#note-boxes

- Replaced > quotes with <div> tags and added appropriate classes for note boxes.
- Included markdown="1" attribute to ensure nested markdown is displayed properly.
Removed extra blank lines from setting_up_git.md that were inadvertently included in a previous commit.
Copy link
Member

@xandora xandora left a comment

Choose a reason for hiding this comment

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

@theSamyak Thanks for working on the previous suggestions, just a couple of minor touches needed to get this ready to go.

foundations/installations/setting_up_git.md Outdated Show resolved Hide resolved
foundations/installations/setting_up_git.md Show resolved Hide resolved
theSamyak and others added 2 commits June 22, 2024 16:57
Co-authored-by: Michael Frank <michael@mfrnk.nz>
Co-authored-by: Michael Frank <michael@mfrnk.nz>
@theSamyak
Copy link
Contributor Author

@theSamyak Thanks for working on the previous suggestions, just a couple of minor touches needed to get this ready to go.

Hi, I messed up my commit history and there is still some linting issue and I apologize for it. I have cloned the project into VS Code and from now on, will make the changes and contributions from there to maintain a cleaner commit history and preserve my sanity. Thanks.

Copy link
Member

@xandora xandora left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@xandora xandora merged commit 004f1bf into TheOdinProject:main Jun 22, 2024
3 checks passed
@theSamyak theSamyak deleted the patch-5 branch June 22, 2024 19:44
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.

Setting up Git: A partition between two topics
2 participants