Skip to content

Commit

Permalink
Improved Git-Github Roadmap (#7218)
Browse files Browse the repository at this point in the history
Cleaned spelling and grammatical issues in topics. Added new, official links to docs etc.

---------

Co-authored-by: dsh <[email protected]>
  • Loading branch information
offensive-vk and dansholds authored Sep 24, 2024
1 parent 3786c91 commit b265da3
Show file tree
Hide file tree
Showing 42 changed files with 99 additions and 53 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Caching Dependencies

GitHub Actions provides a caching feature that allows you to store and reuse dependencies between workflows, reducing the time it takes to run your actions. By caching dependencies, you can:

- Reuse compiled code
- Store database connections
- Reduce network traffic
Expand Down
6 changes: 3 additions & 3 deletions ...ata/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Cherry-picking in Git allows you to apply a specific commit from one branch to a

Visit the following resources to learn more:

- [@official@git-cherry-pick-docs](https://git-scm.com/docs/git-cherry-pick)
- [@article@Git cherry pick](https://www.atlassian.com/git/tutorials/cherry-pick)
- [@video@Git-CHERRY-PICK-Tutorial](https://youtu.be/i657Bg_HAWI?si=3jjn2X8Hi1na--F4)
- [@official@git-cherry-pick docs](https://git-scm.com/docs/git-cherry-pick)
- [@article@Git Cherry Pick](https://www.atlassian.com/git/tutorials/cherry-pick)
- [@video@Git Cherry Pick - Tutorial](https://youtu.be/i657Bg_HAWI?si=3jjn2X8Hi1na--F4)
4 changes: 2 additions & 2 deletions src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Clean Git History

Cleaning up Git history can make your commit history more readable, concise, and organized. Here are some of the reasons why you'd want to clean your git history:
Cleaning up Git history can make your commit history more readable, concise, and organized. Here are some of the reasons why you'd want to clean your git history:

- makes it easy to decipher the order of the commits in your repository
- It facilitates finding commits that might have introduced bugs and enable rollback if necessary
Expand All @@ -10,4 +10,4 @@ Cleaning up Git history can make your commit history more readable, concise, and
Visit the following resources to learn more:

- [@article@Clean GIT history — a Step by Step Guide](https://medium.com/@catalinaturlea/clean-git-history-a-step-by-step-guide-eefc0ad8696d)
- [@video@Git best practice tip: clean commit history](https://youtu.be/bZpiVijzd2g?si=8lJTlR3LfY9ZUd77)
- [@video@Git Best Practice Tip: Clean Commit History](https://youtu.be/bZpiVijzd2g?si=8lJTlR3LfY9ZUd77)
9 changes: 5 additions & 4 deletions src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Cloning Repositories

Cloning a repository in Git and GitHub involves creating a local copy of a remote repository on your computer. This allows you to work on the project locally, commit changes, and later push those changes back to the remote repository.

Visit the following resources to learn more:

- [@official@Git clone](https://git-scm.com/docs/git-clone/en)
- [@official@Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
- [@article@Clone a git respository](https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone)
- [@video@Cloning remote respository into local machine](https://youtu.be/xeQih8LVtZM?si=djlyTDpLNS0oyqQH)
- [@official@git clone](https://git-scm.com/docs/git-clone/en)
- [@official@Cloning a Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
- [@article@Clone a Git Repository](https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone)
- [@video@Cloning Remote Repository into local machine](https://youtu.be/xeQih8LVtZM?si=djlyTDpLNS0oyqQH)
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
The purpose of a code review in software development is to help ensure that the code meets the organization’s standards and requirements, is of high quality, and is maintainable. In addition to identifying errors and bugs, code reviews also promote a culture of learning and collaboration among the development team.

Some of the benefits of code reviews include:

- Increase code quality by identifying defects in the code and issues such as security vulnerabilities and performance problems—before developers merge the code into an upstream branch.
- Ensure compliance with organizational standards, regulations, and the team’s code style.
- Save time and money by detecting issues earlier in the software development process before they become more complex and expensive to fix.
Expand Down
2 changes: 1 addition & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Collaboration

When working on projects with others, Git provides tools to facilitate collaboration through forking repositories using `git clone` or `git fork`, cloning them locally with git clone, managing pull requests with `git request-pull`, and resolving merge conflicts. To contribute effectively, follow established contributing guides and respect open-source licences that govern how contributors' work may be used by others.
When working on projects with others, Git provides tools to facilitate collaboration through forking repositories using `git clone` or `git fork`, cloning them locally with git clone, managing pull requests with `git request-pull`, and resolving merge conflicts. To contribute effectively, follow established contributing guides and respect open-source licenses that govern how contributors' work may be used by others.

Visit the following resources to learn more:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contribution Guidelines

Contribution guidelines are essential for collaborative projects on GitHub as they help streamline collaboration, set expectations for contributions, and maintain the project's quality and consistency.
Contribution guidelines are essential for collaborative projects on GitHub as they help streamline collaboration, set expectations for contributions, and maintain the project's quality and consistency.

Visit the following resources to learn more:

- [@official@Setting guidelines for respository contributors](https://docs.github.com/articles/setting-guidelines-for-repository-contributors)
- [@official@Setting Guidelines for Repository Contributors](https://docs.github.com/articles/setting-guidelines-for-repository-contributors)
- [@official@Contributing Guidelines](https://github.blog/news-insights/contributing-guidelines/)
- [@official@Contributing Guides: A Template](https://github.com/nayafia/contributing-template)
- [@article@How to Build a CONTRIBUTING.md](https://mozillascience.github.io/working-open-workshop/contributing/)
2 changes: 1 addition & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ To get started with GitHub, you'll need to create a free personal account on Git

Visit the following resources to learn more:

- [@official@Creating an account on GitHub](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github)
- [@official@Creating an Account on GitHub](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating Repositories

Creating a Git repository means setting up a system to track changes in your project's files over time. This is crucial for version control, allowing you to manage, review, and collaborate on code efficiently.
Creating a Git repository means setting up a system to track changes in your project's files over time. This is crucial for version control, allowing you to manage, review, and collaborate on code efficiently.

Visit the following resources to learn more:

Expand Down
2 changes: 1 addition & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ On GitHub Pages, users can customize their site's URL by connecting a custom dom

Visit the following resources to learn more:

- [@official@Configuring a custom domain for your GitHub Pages site](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site)
- [@official@Configuring a Custom Domain for Your GitHub Pages Site](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site)
- [@video@How to Host a Website on GitHub Pages Free (Custom Domain Setup Included)](https://www.youtube.com/watch?v=e5AwNU3Y2es&t=156s)
2 changes: 1 addition & 1 deletion .../roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Deploying static websites on GitHub Pages involves uploading and serving website

Visit the following resources to learn more:

- [@arcticle@How to Deploy a Static Website for Free Using Github Pages](https://medium.com/flycode/how-to-deploy-a-static-website-for-free-using-github-pages-8eddc194853b)
- [@article@How to Deploy a Static Website for Free Using Github Pages](https://medium.com/flycode/how-to-deploy-a-static-website-for-free-using-github-pages-8eddc194853b)
- [@video@How to Host a Website on GitHub Pages Free (Custom Domain Setup Included)](https://www.youtube.com/watch?v=e5AwNU3Y2es)
2 changes: 1 addition & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can use `git filter-branch` to rewrite Git revision history by applying cust

Notably, there exists a simpler, safer, and more powerful alternative: `git filter-repo`. This tool is actively promoted by Git and offers a streamlined approach to filtering revisions, making it a preferred choice for rewriting your Git history, especially when managing large repositories.

Visit the following resources to learn more:
Visit the following resources to learn more:

- [@official@git filter-branch](https://git-scm.com/docs/git-filter-branch)
- [@official@git filter-repo](https://github.com/newren/git-filter-repo)
Expand Down
1 change: 1 addition & 0 deletions src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Here are some common git log options:

- `-2`: Only show the last two commits.
- `-- <file-name>`: Show the commits that modified a specific file.
- `--all`: Show all branches in the repository.
- `--graph`: Display the commit history as a graph.
- `--pretty`: Enable clean colorized output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Git rebase is a powerful command in Git that allows you to integrate changes fro
Visit the following resources to learn more:

- [@official@Git - git-rebase Documentation](https://git-scm.com/docs/git-rebase)
- [@article@git rebase ](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase)
- [@article@git rebase](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase)
- [@video@git rebase - Why, When &amp; How to fix conflicts](https://youtu.be/DkWDHzmMvyg?si=59jauQgkL-sMewzo)
- [@video@Git Rebase --interactive: EXPLAINED](https://youtu.be/H7RFt0Pxxp8?si=gLhfkVW_PmWHBQSs)
2 changes: 1 addition & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ In Git, a remote is a reference to a repository that exists on another server or

Visit the following resources to learn more:

- [@article@About remote repositories](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories)
- [@official@About Remote Repositories](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories)
- [@video@What is a Remote Repository? [Beginner Git Tutorial]](https://www.youtube.com/watch?v=Lb4yvfrX_7I)
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Git reset is a command that allows you to "undo" or reset your current branch to

Visit the following resources to learn more:

- [@article@Git reset](https://www.atlassian.com/git/tutorials/undoing-changes/git-reset)
- [@article@git reset](https://www.atlassian.com/git/tutorials/undoing-changes/git-reset)
- [@video@Git Reset | How to Use Git Reset | Learn Git](https://www.youtube.com/watch?v=s1idhUiCk38)
4 changes: 3 additions & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ One of the best ways to learn about GitHub Actions is through the course offered

Visit the following resources to learn more:

- [@official@Github Actions](https://docs.github.com/en/actions)
- [@course@Microsoft Learn: Introduction to GitHub Actions](https://learn.microsoft.com/en-us/collections/n5p4a5z7keznp5)
- [@course@YouTube: GitHub Actions Playlist](https://www.youtube.com/watch?v=-hVG9z0fCac&list=PLArH6NjfKsUhvGHrpag7SuPumMzQRhUKY&pp=iAQB)
- [@course@YouTube: GitHub Actions Playlist](https://www.youtube.com/watch?v=-hVG9z0fCac&list=PLArH6NjfKsUhvGHrpag7SuPumMzQRhUKY&pp=iAQB)
- [@video@What are Github Actions](https://www.youtube.com/watch?v=URmeTqglS58)
4 changes: 2 additions & 2 deletions src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ The GitHub API is a powerful tool that allows developers to interact with the Gi

Visit the following resources to learn more:

- [@official@official API Docs](https://docs.github.com/en/rest?apiVersion=2022-11-28)
- [@article@Getting started](https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api?apiVersion=2022-11-28)
- [@official@Github API Docs](https://docs.github.com/en/rest?apiVersion=2022-11-28)
- [@article@Getting Started](https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api?apiVersion=2022-11-28)
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ GitHub CLI is a command-line interface tool that brings GitHub functionality to

Visit the following resources to learn more:

- [@official@official GitHub CLI Docs](https://cli.github.com/)
- [@official@GitHub CLI Docs](https://cli.github.com/)
- [@video@What is the GitHub CLI?](https://www.youtube.com/watch?v=uy_PEGgUF4U)
4 changes: 2 additions & 2 deletions src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ GitHub Discussions is a collaborative communication feature within GitHub reposi

Visit the following resources to learn more:

- [@video@What is GitHub Discussions?](https://www.youtube.com/watch?v=bErGYN3Ljz8)
- [@official@official GitHub Discussions Docs](https://docs.github.com/en/discussions)
- [@official@GitHub Discussions Docs](https://docs.github.com/en/discussions)
- [@video@What is GitHub Discussions?](https://www.youtube.com/watch?v=bErGYN3Ljz8)
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# GitHub Essentials

GitHub Essentials refers to the core features and functionalities that form the foundation of GitHub's version control and collaboration platform. These essentials include repositories for storing and managing code, branches for parallel development, pull requests for code review and merging, issues for tracking tasks and bugs, and collaborative tools like project boards and wikis. Understanding and mastering these fundamental components allows developers to effectively manage their projects, collaborate with team members, and contribute to open-source initiatives, making GitHub an indispensable tool in modern software development workflows.
GitHub Essentials refers to the core features and functionalities that form the foundation of GitHub's version control and collaboration platform. These essentials include repositories for storing and managing code, branches for parallel development, pull requests for code review and merging, issues for tracking tasks and bugs, and collaborative tools like project boards and wikis. Understanding and mastering these fundamental components allows developers to effectively manage their projects, collaborate with team members, and contribute to open-source initiatives, making GitHub an indispensable tool in modern software development workflows.

Visit the following resources to learn more:

- [@official@Github Essentials - Microsoft](https://learn.microsoft.com/en-us/contribute/content/git-github-fundamentals)
- [@official@Hello World](https://docs.github.com/en/get-started/start-your-journey/hello-world)
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ A GitHub Gist is a small code or text snippet that can be shared with others. It

Visit the following resources to learn more:

- [@official@Creating gists](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)
- [@official@REST API endpoints for gists](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28)
- [@official@Creating Gists](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)
- [@official@REST API endpoints for Gists](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28)
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ GitHub Pages is a feature that allows users to host and publish web content dire
Visit the following resources to learn more:

- [@official@About GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages)
- [@official@Ceating a GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site)
- [@official@Creating a GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site)
- [@official@GitHub Pages examples](https://github.com/collections/github-pages-examples)
2 changes: 1 addition & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ GitHub Security is a suite of features and tools that help developers identify,
Visit the following resources to learn more:

- [@official@GitHub security features](https://docs.github.com/en/code-security/getting-started/github-security-features)
- [@official@Dependabot quickstart guide](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
- [@official@Dependabot Quick-start Guide](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
- [@official@About user alerts](https://docs.github.com/en/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts#about-user-alerts)
2 changes: 1 addition & 1 deletion ...ata/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Visit the following resources to learn more:

- [@official@GitHub CLI - Installation](https://github.com/cli/cli?tab=readme-ov-file#installation)
- [@official@GitHub CLI - Release](https://github.com/cli/cli/releases/)
- [@official@GitHub CLI quickstart](https://docs.github.com/en/github-cli/github-cli/quickstart)
- [@official@GitHub CLI Quickstart](https://docs.github.com/en/github-cli/github-cli/quickstart)
6 changes: 5 additions & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Mentions

Mentions on GitHub allow you to notify specific users or teams about comments, issues, pull requests, or other activities. This feature improves collaboration by encouraging participation and discussion among team members, increasing visibility of important topics, and streamlining communication within your repository. To use mentions, simply type `@username` or `@teamname` in a comment, and GitHub will auto-complete the mention as you type, automatically linking their username to the comment and notifying them about the discussion.
Mentions on GitHub allow you to notify specific users or teams about comments, issues, pull requests, or other activities. This feature improves collaboration by encouraging participation and discussion among team members, increasing visibility of important topics, and streamlining communication within your repository. To use mentions, simply type `@username` or `@teamname` in a comment, and GitHub will auto-complete the mention as you type, automatically linking their username to the comment and notifying them about the discussion.

Visit the following resources to learn more:

- [@official@Mention Somebody](https://github.blog/news-insights/mention-somebody-they-re-notified/)
7 changes: 6 additions & 1 deletion src/data/roadmaps/git-github/content/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,9 @@ When combining changes from one branch into another, Git provides various merge
- Non-Fast Forward
- Rebase
- Squash
- Cherry Picking
- Cherry Picking

Visit the following resources to learn more:

- [@official@Git Merge Strategies](https://git-scm.com/docs/merge-strategies)
- [@article@Git Merge Options](https://www.atlassian.com/git/tutorials/using-branches/merge-strategy)
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Pull Request (PR) guidelines are essential for maintaining a smooth and efficien

Visit the following resources to learn more:

- [@official@Best practices for pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests)
- [@official@Best Practices for Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests)
- [@article@Pull Request Guidelines](https://opensource.creativecommons.org/contributing-code/pr-guidelines/)
Loading

0 comments on commit b265da3

Please sign in to comment.