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

Git Basics: Added a beginner-friendly git handbook to additional resources #27886

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

theSamyak
Copy link

Added beginner-friendly Git fundamentals handbook to additional resources.

Because

This PR introduces a beginner-friendly Git fundamentals handbook into The Odin Project's additional resources. The handbook is easy for beginners to understand, with clear explanations and step-by-step instructions on Git basics. Its inclusion aims to significantly benefit students by providing them with a comprehensive and accessible resource to learn Git fundamentals effectively. Furthermore, the handbook has gained recognition within the community, having been featured in multiple newsletters and promoted by an official Microsoft page on Twitter, further validating its quality and usefulness.

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

Added beginner-friendly Git fundamentals handbook to additional resources.
@github-actions github-actions bot added the Content: Git Involves Git content label Apr 29, 2024
Copy link
Member

@wise-king-sullyman wise-king-sullyman left a comment

Choose a reason for hiding this comment

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

Thank you for taking the time to make this PR, but we are very intentional about when and where we introduce different Git concepts so this wouldn't really fit with our approach to the subject.

Honestly, we should probably look at removing all additional resources there for that same reason. I would wager most of them predate our shift in how we cover Git.

Is that something you would be interested in doing?

@theSamyak theSamyak closed this Apr 30, 2024
@theSamyak theSamyak reopened this Apr 30, 2024
@theSamyak
Copy link
Author

theSamyak commented Apr 30, 2024

Thank you for taking the time to make this PR, but we are very intentional about when and where we introduce different Git concepts so this wouldn't really fit with our approach to the subject.

Honestly, we should probably look at removing all additional resources there for that same reason. I would wager most of them predate our shift in how we cover Git.

Is that something you would be interested in doing?

Thank you very much for taking the time to review my pull request and for providing feedback. I truly appreciate the effort you and the team put into maintaining the Odin Project.

I've made the necessary changes as per your suggestion and removed all additional resources from the Git section of The Odin Project's curriculum.

If there are any further adjustments you'd like to make, such as removing additional resources or any other contributions you'd like assistance with, please don't hesitate to let me know. I'm more than willing to collaborate further in any capacity that aligns with the project's goals and in whatever capacity I can.

In response to feedback from Austin Sullivan [wise-king-sullyman], this commit removes all additional resources from the Git section of The Odin Project's curriculum. The decision to remove these resources was made to ensure consistency and relevance within the curriculum, aligning with the project's teaching approach.
Removed the "Additional Resources" heading from the markdownlint/docs/TOP004.md - Lesson headings.
Copy link
Member

@wise-king-sullyman wise-king-sullyman left a comment

Choose a reason for hiding this comment

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

Thank you for making these changes! This isn't quite the approach we would want to take though.

@@ -18,7 +18,6 @@ Currently, the required headings depend on the content's type:
### Assignment
#### * (Wildcard: Any subheading at the h4 level)
### Knowledge Check
### Additional Resources
Copy link
Member

Choose a reason for hiding this comment

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

We want to keep the additional resources section as required.

Comment on lines 203 to 205
### Additional resources

This section contains helpful links to related content. It isn't required, so consider it supplemental.
Copy link
Member

Choose a reason for hiding this comment

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

We'll want to keep this section with the bullet below added as we outline in our lesson layout guide

- It looks like this lesson doesn't have any additional resources yet. Help us expand this section by contributing to our curriculum.

Restored the "Additional Resources" heading in the Lessons heading Structure @ markdownlint/docs/TOP004.md.
…l Resources

Added a bullet point in the "Additional resources" section to encourage community contributions for expanding the resources available.
@theSamyak
Copy link
Author

The changes have been made as suggested. Is there anything else I can assist with or any further adjustments required? Please let me know. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: Git Involves Git content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants