From b265da3b37cfbbcbb7faf564f8ae8ee9458fdf95 Mon Sep 17 00:00:00 2001 From: Vedansh Date: Tue, 24 Sep 2024 19:22:35 +0530 Subject: [PATCH] Improved Git-Github Roadmap (#7218) Cleaned spelling and grammatical issues in topics. Added new, official links to docs etc. --------- Co-authored-by: dsh --- .../caching-dependencies@HMNhzzV6ApTKj4I_FOmUB.md | 1 + .../cherry-picking-commits@eFf2fesrs-1aVM5tH3ORQ.md | 6 +++--- .../content/clean-git-history@i3AbARgzQtxtlB-1AS8zv.md | 4 ++-- .../cloning-repositories@1Koej79yTv-OAswVZwgGq.md | 9 +++++---- .../content/code-reviews@xLB2fhsOm0Vu3xg_PusJB.md | 1 + .../content/collaboration@bXfCUG3h1TIFPgD4WUDph.md | 2 +- .../contribution-guidelines@pJ-najh7dXhhYA_0bDiR5.md | 4 ++-- .../content/creating-account@i7fIIHcBEk473te8bniJ5.md | 2 +- .../creating-repositories@c_FO6xMixrrMo6iisfsvl.md | 2 +- .../content/custom-domains@VdoxEWaU56-QCbHFRw649.md | 2 +- .../deploying-static-websites@ZHplGidvhxEIC3HN8KqRa.md | 2 +- .../content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md | 2 +- .../content/git-log-options@qFEonbCMLri8iA0yONwuf.md | 1 + .../content/git-rebase@HMEfUFNu_Wp_Pac7VWHr-.md | 2 +- .../content/git-remotes@aWx9WHUrgofcTr8B-fQYe.md | 2 +- .../content/git-reset@igrR7LguU1jemg_mf_AD6.md | 2 +- .../content/github-actions@AmetdCURXXob5TUsikAab.md | 4 +++- .../content/github-api@NV2HAXLEN7tskfgyFrbaf.md | 4 ++-- .../content/github-cli@h9cf_dh_pwjialOXOlNW-.md | 2 +- .../content/github-discussions@snWQHCQECZyUXHdn6ppIk.md | 4 ++-- .../content/github-essentials@NeSvgS2yA5x8qbcJHrV__.md | 7 ++++++- .../content/github-gists@M2_hBvXou7cCNqsMnexCt.md | 4 ++-- .../content/github-pages@bnai6R6pOq_L5CPdbVwMW.md | 2 +- .../content/github-security@f2PG4t6iVtfIH8BVe5H7f.md | 2 +- .../installation-and-setup@vHfpoVbOW0DHNtiy0VN4X.md | 2 +- .../git-github/content/mentions@oWMaOWU06juoIuzXNe-wt.md | 6 +++++- .../content/merge-strategies@0rHDUbAdXqH9zQW2VfJ8v.md | 7 ++++++- .../content/pr-guidelines@GwDNk2HBjASr_NWIL4G3-.md | 2 +- .../git-github/content/pre-push@j5kWEUKwBFg5EMm8-61K9.md | 1 - .../content/profile-readme@KbVvFVQ4k77R2_ddsc7WT.md | 3 +-- .../pushing--pulling-changes@ZVMCh9om37ee1qsecFa-N.md | 2 +- .../content/renaming-branch@_dPOVUbxApx0pfKPH8fgr.md | 2 +- .../content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md | 7 ++++++- .../git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md | 4 ++-- .../content/submodules@fjAFNjNNbPOzme9Uk_fDV.md | 7 ++++++- .../teams-within-organization@wydgCxR5VnieBpRolXt8i.md | 4 ++-- .../content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md | 8 +++++++- .../git-github/content/usecases@PUnYNBrAZWoZiopjtNgnA.md | 2 -- .../content/viewing-diffs@-0zQvCHG8jS_ghSjmTeIx.md | 7 ++++++- .../content/what-and-why-use@d0-u_-_vtPK8tnUpnj_NB.md | 6 ++++-- .../content/working-in-a-team@yMx3LdadPz4g25CL3N8da.md | 7 ++++++- .../content/yaml-syntax@p6rq3lQ9YRrTqwcc31O23.md | 2 ++ 42 files changed, 99 insertions(+), 53 deletions(-) diff --git a/src/data/roadmaps/git-github/content/caching-dependencies@HMNhzzV6ApTKj4I_FOmUB.md b/src/data/roadmaps/git-github/content/caching-dependencies@HMNhzzV6ApTKj4I_FOmUB.md index 3ba65d469..51e03846c 100644 --- a/src/data/roadmaps/git-github/content/caching-dependencies@HMNhzzV6ApTKj4I_FOmUB.md +++ b/src/data/roadmaps/git-github/content/caching-dependencies@HMNhzzV6ApTKj4I_FOmUB.md @@ -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 diff --git a/src/data/roadmaps/git-github/content/cherry-picking-commits@eFf2fesrs-1aVM5tH3ORQ.md b/src/data/roadmaps/git-github/content/cherry-picking-commits@eFf2fesrs-1aVM5tH3ORQ.md index 08a46604b..d70df3d71 100644 --- a/src/data/roadmaps/git-github/content/cherry-picking-commits@eFf2fesrs-1aVM5tH3ORQ.md +++ b/src/data/roadmaps/git-github/content/cherry-picking-commits@eFf2fesrs-1aVM5tH3ORQ.md @@ -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) \ No newline at end of file +- [@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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/clean-git-history@i3AbARgzQtxtlB-1AS8zv.md b/src/data/roadmaps/git-github/content/clean-git-history@i3AbARgzQtxtlB-1AS8zv.md index b86ebfda3..6eb2d4bc0 100644 --- a/src/data/roadmaps/git-github/content/clean-git-history@i3AbARgzQtxtlB-1AS8zv.md +++ b/src/data/roadmaps/git-github/content/clean-git-history@i3AbARgzQtxtlB-1AS8zv.md @@ -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 @@ -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) \ No newline at end of file +- [@video@Git Best Practice Tip: Clean Commit History](https://youtu.be/bZpiVijzd2g?si=8lJTlR3LfY9ZUd77) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/cloning-repositories@1Koej79yTv-OAswVZwgGq.md b/src/data/roadmaps/git-github/content/cloning-repositories@1Koej79yTv-OAswVZwgGq.md index cbb82058e..2a0701d92 100644 --- a/src/data/roadmaps/git-github/content/cloning-repositories@1Koej79yTv-OAswVZwgGq.md +++ b/src/data/roadmaps/git-github/content/cloning-repositories@1Koej79yTv-OAswVZwgGq.md @@ -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) \ No newline at end of file +- [@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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/code-reviews@xLB2fhsOm0Vu3xg_PusJB.md b/src/data/roadmaps/git-github/content/code-reviews@xLB2fhsOm0Vu3xg_PusJB.md index f5ba875a6..a1230753c 100644 --- a/src/data/roadmaps/git-github/content/code-reviews@xLB2fhsOm0Vu3xg_PusJB.md +++ b/src/data/roadmaps/git-github/content/code-reviews@xLB2fhsOm0Vu3xg_PusJB.md @@ -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. diff --git a/src/data/roadmaps/git-github/content/collaboration@bXfCUG3h1TIFPgD4WUDph.md b/src/data/roadmaps/git-github/content/collaboration@bXfCUG3h1TIFPgD4WUDph.md index 08a2b5fea..ce27d2b9f 100644 --- a/src/data/roadmaps/git-github/content/collaboration@bXfCUG3h1TIFPgD4WUDph.md +++ b/src/data/roadmaps/git-github/content/collaboration@bXfCUG3h1TIFPgD4WUDph.md @@ -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: diff --git a/src/data/roadmaps/git-github/content/contribution-guidelines@pJ-najh7dXhhYA_0bDiR5.md b/src/data/roadmaps/git-github/content/contribution-guidelines@pJ-najh7dXhhYA_0bDiR5.md index 20d77b3e3..dcf513682 100644 --- a/src/data/roadmaps/git-github/content/contribution-guidelines@pJ-najh7dXhhYA_0bDiR5.md +++ b/src/data/roadmaps/git-github/content/contribution-guidelines@pJ-najh7dXhhYA_0bDiR5.md @@ -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/) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/creating-account@i7fIIHcBEk473te8bniJ5.md b/src/data/roadmaps/git-github/content/creating-account@i7fIIHcBEk473te8bniJ5.md index 24cb75609..b52de9fe1 100644 --- a/src/data/roadmaps/git-github/content/creating-account@i7fIIHcBEk473te8bniJ5.md +++ b/src/data/roadmaps/git-github/content/creating-account@i7fIIHcBEk473te8bniJ5.md @@ -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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/creating-repositories@c_FO6xMixrrMo6iisfsvl.md b/src/data/roadmaps/git-github/content/creating-repositories@c_FO6xMixrrMo6iisfsvl.md index ed9f24690..b03d91fa8 100644 --- a/src/data/roadmaps/git-github/content/creating-repositories@c_FO6xMixrrMo6iisfsvl.md +++ b/src/data/roadmaps/git-github/content/creating-repositories@c_FO6xMixrrMo6iisfsvl.md @@ -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: diff --git a/src/data/roadmaps/git-github/content/custom-domains@VdoxEWaU56-QCbHFRw649.md b/src/data/roadmaps/git-github/content/custom-domains@VdoxEWaU56-QCbHFRw649.md index dfb5ad74d..34ec09fe3 100644 --- a/src/data/roadmaps/git-github/content/custom-domains@VdoxEWaU56-QCbHFRw649.md +++ b/src/data/roadmaps/git-github/content/custom-domains@VdoxEWaU56-QCbHFRw649.md @@ -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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/deploying-static-websites@ZHplGidvhxEIC3HN8KqRa.md b/src/data/roadmaps/git-github/content/deploying-static-websites@ZHplGidvhxEIC3HN8KqRa.md index 0cf6fad2f..915a57d67 100644 --- a/src/data/roadmaps/git-github/content/deploying-static-websites@ZHplGidvhxEIC3HN8KqRa.md +++ b/src/data/roadmaps/git-github/content/deploying-static-websites@ZHplGidvhxEIC3HN8KqRa.md @@ -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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md b/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md index a74bc7026..f4339dfa9 100644 --- a/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md +++ b/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md @@ -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) diff --git a/src/data/roadmaps/git-github/content/git-log-options@qFEonbCMLri8iA0yONwuf.md b/src/data/roadmaps/git-github/content/git-log-options@qFEonbCMLri8iA0yONwuf.md index 90ac1c45e..393600bdf 100644 --- a/src/data/roadmaps/git-github/content/git-log-options@qFEonbCMLri8iA0yONwuf.md +++ b/src/data/roadmaps/git-github/content/git-log-options@qFEonbCMLri8iA0yONwuf.md @@ -5,6 +5,7 @@ Here are some common git log options: - `-2`: Only show the last two commits. +- `-- `: 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. diff --git a/src/data/roadmaps/git-github/content/git-rebase@HMEfUFNu_Wp_Pac7VWHr-.md b/src/data/roadmaps/git-github/content/git-rebase@HMEfUFNu_Wp_Pac7VWHr-.md index 1153f0838..10cdb2008 100644 --- a/src/data/roadmaps/git-github/content/git-rebase@HMEfUFNu_Wp_Pac7VWHr-.md +++ b/src/data/roadmaps/git-github/content/git-rebase@HMEfUFNu_Wp_Pac7VWHr-.md @@ -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 & How to fix conflicts](https://youtu.be/DkWDHzmMvyg?si=59jauQgkL-sMewzo) - [@video@Git Rebase --interactive: EXPLAINED](https://youtu.be/H7RFt0Pxxp8?si=gLhfkVW_PmWHBQSs) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/git-remotes@aWx9WHUrgofcTr8B-fQYe.md b/src/data/roadmaps/git-github/content/git-remotes@aWx9WHUrgofcTr8B-fQYe.md index 6895d8362..cb11378b8 100644 --- a/src/data/roadmaps/git-github/content/git-remotes@aWx9WHUrgofcTr8B-fQYe.md +++ b/src/data/roadmaps/git-github/content/git-remotes@aWx9WHUrgofcTr8B-fQYe.md @@ -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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/git-reset@igrR7LguU1jemg_mf_AD6.md b/src/data/roadmaps/git-github/content/git-reset@igrR7LguU1jemg_mf_AD6.md index 8db3f100f..52428f35e 100644 --- a/src/data/roadmaps/git-github/content/git-reset@igrR7LguU1jemg_mf_AD6.md +++ b/src/data/roadmaps/git-github/content/git-reset@igrR7LguU1jemg_mf_AD6.md @@ -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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/github-actions@AmetdCURXXob5TUsikAab.md b/src/data/roadmaps/git-github/content/github-actions@AmetdCURXXob5TUsikAab.md index 08434a058..4d8b69cf7 100644 --- a/src/data/roadmaps/git-github/content/github-actions@AmetdCURXXob5TUsikAab.md +++ b/src/data/roadmaps/git-github/content/github-actions@AmetdCURXXob5TUsikAab.md @@ -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) \ No newline at end of file +- [@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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/github-api@NV2HAXLEN7tskfgyFrbaf.md b/src/data/roadmaps/git-github/content/github-api@NV2HAXLEN7tskfgyFrbaf.md index 741ce88f5..03394829b 100644 --- a/src/data/roadmaps/git-github/content/github-api@NV2HAXLEN7tskfgyFrbaf.md +++ b/src/data/roadmaps/git-github/content/github-api@NV2HAXLEN7tskfgyFrbaf.md @@ -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) \ No newline at end of file +- [@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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/github-cli@h9cf_dh_pwjialOXOlNW-.md b/src/data/roadmaps/git-github/content/github-cli@h9cf_dh_pwjialOXOlNW-.md index d92e7a6bd..08872ec31 100644 --- a/src/data/roadmaps/git-github/content/github-cli@h9cf_dh_pwjialOXOlNW-.md +++ b/src/data/roadmaps/git-github/content/github-cli@h9cf_dh_pwjialOXOlNW-.md @@ -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) diff --git a/src/data/roadmaps/git-github/content/github-discussions@snWQHCQECZyUXHdn6ppIk.md b/src/data/roadmaps/git-github/content/github-discussions@snWQHCQECZyUXHdn6ppIk.md index 733f9dd36..f14d40ea0 100644 --- a/src/data/roadmaps/git-github/content/github-discussions@snWQHCQECZyUXHdn6ppIk.md +++ b/src/data/roadmaps/git-github/content/github-discussions@snWQHCQECZyUXHdn6ppIk.md @@ -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) \ No newline at end of file +- [@official@GitHub Discussions Docs](https://docs.github.com/en/discussions) +- [@video@What is GitHub Discussions?](https://www.youtube.com/watch?v=bErGYN3Ljz8) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/github-essentials@NeSvgS2yA5x8qbcJHrV__.md b/src/data/roadmaps/git-github/content/github-essentials@NeSvgS2yA5x8qbcJHrV__.md index b5cbab580..10230ec3e 100644 --- a/src/data/roadmaps/git-github/content/github-essentials@NeSvgS2yA5x8qbcJHrV__.md +++ b/src/data/roadmaps/git-github/content/github-essentials@NeSvgS2yA5x8qbcJHrV__.md @@ -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. \ No newline at end of file +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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/github-gists@M2_hBvXou7cCNqsMnexCt.md b/src/data/roadmaps/git-github/content/github-gists@M2_hBvXou7cCNqsMnexCt.md index 77bc688a2..cb9ba080b 100644 --- a/src/data/roadmaps/git-github/content/github-gists@M2_hBvXou7cCNqsMnexCt.md +++ b/src/data/roadmaps/git-github/content/github-gists@M2_hBvXou7cCNqsMnexCt.md @@ -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) \ No newline at end of file +- [@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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/github-pages@bnai6R6pOq_L5CPdbVwMW.md b/src/data/roadmaps/git-github/content/github-pages@bnai6R6pOq_L5CPdbVwMW.md index 275f748fa..149b3403b 100644 --- a/src/data/roadmaps/git-github/content/github-pages@bnai6R6pOq_L5CPdbVwMW.md +++ b/src/data/roadmaps/git-github/content/github-pages@bnai6R6pOq_L5CPdbVwMW.md @@ -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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/github-security@f2PG4t6iVtfIH8BVe5H7f.md b/src/data/roadmaps/git-github/content/github-security@f2PG4t6iVtfIH8BVe5H7f.md index 01137aef3..54c920423 100644 --- a/src/data/roadmaps/git-github/content/github-security@f2PG4t6iVtfIH8BVe5H7f.md +++ b/src/data/roadmaps/git-github/content/github-security@f2PG4t6iVtfIH8BVe5H7f.md @@ -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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/installation-and-setup@vHfpoVbOW0DHNtiy0VN4X.md b/src/data/roadmaps/git-github/content/installation-and-setup@vHfpoVbOW0DHNtiy0VN4X.md index 472dd064a..7ee1fca2a 100644 --- a/src/data/roadmaps/git-github/content/installation-and-setup@vHfpoVbOW0DHNtiy0VN4X.md +++ b/src/data/roadmaps/git-github/content/installation-and-setup@vHfpoVbOW0DHNtiy0VN4X.md @@ -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) \ No newline at end of file +- [@official@GitHub CLI Quickstart](https://docs.github.com/en/github-cli/github-cli/quickstart) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/mentions@oWMaOWU06juoIuzXNe-wt.md b/src/data/roadmaps/git-github/content/mentions@oWMaOWU06juoIuzXNe-wt.md index a1e620944..168e001a2 100644 --- a/src/data/roadmaps/git-github/content/mentions@oWMaOWU06juoIuzXNe-wt.md +++ b/src/data/roadmaps/git-github/content/mentions@oWMaOWU06juoIuzXNe-wt.md @@ -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. \ No newline at end of file +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/) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/merge-strategies@0rHDUbAdXqH9zQW2VfJ8v.md b/src/data/roadmaps/git-github/content/merge-strategies@0rHDUbAdXqH9zQW2VfJ8v.md index fc5c5b3ed..b155765ef 100644 --- a/src/data/roadmaps/git-github/content/merge-strategies@0rHDUbAdXqH9zQW2VfJ8v.md +++ b/src/data/roadmaps/git-github/content/merge-strategies@0rHDUbAdXqH9zQW2VfJ8v.md @@ -6,4 +6,9 @@ When combining changes from one branch into another, Git provides various merge - Non-Fast Forward - Rebase - Squash -- Cherry Picking \ No newline at end of file +- 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) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/pr-guidelines@GwDNk2HBjASr_NWIL4G3-.md b/src/data/roadmaps/git-github/content/pr-guidelines@GwDNk2HBjASr_NWIL4G3-.md index 6d1eada20..afe98a758 100644 --- a/src/data/roadmaps/git-github/content/pr-guidelines@GwDNk2HBjASr_NWIL4G3-.md +++ b/src/data/roadmaps/git-github/content/pr-guidelines@GwDNk2HBjASr_NWIL4G3-.md @@ -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/) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/pre-push@j5kWEUKwBFg5EMm8-61K9.md b/src/data/roadmaps/git-github/content/pre-push@j5kWEUKwBFg5EMm8-61K9.md index ef45f789e..03a0c8c29 100644 --- a/src/data/roadmaps/git-github/content/pre-push@j5kWEUKwBFg5EMm8-61K9.md +++ b/src/data/roadmaps/git-github/content/pre-push@j5kWEUKwBFg5EMm8-61K9.md @@ -2,7 +2,6 @@ Git pre-push hooks are scripts that run automatically before a push operation is executed, providing a final checkpoint to validate changes before they are shared with a remote repository. These hooks allow developers to perform last-minute checks, such as running tests, linting code, or verifying commit messages, to ensure that only high-quality and compliant code is pushed. By intercepting the push process, pre-push hooks help maintain code integrity, prevent accidental pushes of incomplete or broken code, and enforce project-specific rules, making them a valuable tool for maintaining code quality and consistency across distributed development teams. - Visit the following resources to learn more: - [@article@pre-push hooks](https://dev.to/jameson/pre-push-hooks-42g5) diff --git a/src/data/roadmaps/git-github/content/profile-readme@KbVvFVQ4k77R2_ddsc7WT.md b/src/data/roadmaps/git-github/content/profile-readme@KbVvFVQ4k77R2_ddsc7WT.md index 6a530772c..2587386c2 100644 --- a/src/data/roadmaps/git-github/content/profile-readme@KbVvFVQ4k77R2_ddsc7WT.md +++ b/src/data/roadmaps/git-github/content/profile-readme@KbVvFVQ4k77R2_ddsc7WT.md @@ -2,8 +2,7 @@ A GitHub Profile README is a special repository that allows users to showcase their skills, projects, and personality directly on their GitHub profile. To create one, you need to make a new repository with the same name as your GitHub username. This repository should contain a README.md file, which GitHub will automatically display on your profile page. The README can be customized with Markdown formatting, allowing you to add text, images, links, and even dynamic content like GitHub stats or recent blog posts. This feature provides a unique opportunity to make your GitHub profile more engaging and informative for visitors, effectively serving as a personalized landing page for your GitHub presence. - Visit the following resources to learn more: -- [@official@Managing your profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme) +- [@official@Managing your Profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme) - [@video@GitHub Profile README](https://www.youtube.com/watch?v=KhGWbt1dAKQ) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/pushing--pulling-changes@ZVMCh9om37ee1qsecFa-N.md b/src/data/roadmaps/git-github/content/pushing--pulling-changes@ZVMCh9om37ee1qsecFa-N.md index eee7e88e4..8ac3b9623 100644 --- a/src/data/roadmaps/git-github/content/pushing--pulling-changes@ZVMCh9om37ee1qsecFa-N.md +++ b/src/data/roadmaps/git-github/content/pushing--pulling-changes@ZVMCh9om37ee1qsecFa-N.md @@ -6,4 +6,4 @@ Visit the following resources to learn more: - [@official@Pushing commits to a remote repository](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository) - [@article@A Comprehensive Guide to git pull and git push](https://dev.to/alexmercedcoder/mastering-git-a-comprehensive-guide-to-git-pull-and-git-push-2eo3) -- [@article@GIT Push and Pull Tutorial](https://www.datacamp.com/tutorial/git-push-pull) \ No newline at end of file +- [@article@Git Push and Pull Tutorial](https://www.datacamp.com/tutorial/git-push-pull) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/renaming-branch@_dPOVUbxApx0pfKPH8fgr.md b/src/data/roadmaps/git-github/content/renaming-branch@_dPOVUbxApx0pfKPH8fgr.md index 3836e15c0..bb5387280 100644 --- a/src/data/roadmaps/git-github/content/renaming-branch@_dPOVUbxApx0pfKPH8fgr.md +++ b/src/data/roadmaps/git-github/content/renaming-branch@_dPOVUbxApx0pfKPH8fgr.md @@ -4,5 +4,5 @@ Renaming a branch in Git means changing the name of a branch to something differ Visit the following resources to learn more: -- [@official@Renaming a branch - GitHub Docs](https://docs.github.com/github/administering-a-repository/renaming-a-branch) +- [@official@Renaming a Branch - GitHub Docs](https://docs.github.com/github/administering-a-repository/renaming-a-branch) - [@article@Git Rename Branch – How to Change a Local Branch Name](https://www.freecodecamp.org/news/git-rename-branch-how-to-change-a-local-branch-name/) diff --git a/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md b/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md index 961ab450e..5f01ba8a1 100644 --- a/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md +++ b/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md @@ -11,4 +11,9 @@ Rewriting history in Git is typically necessary when: - Fixing mistakes: Correcting errors or typos in commit messages. - Removing sensitive data: Deleting confidential information from commits, like API keys or database credentials. -- Simplifying complex histories: Reorganizing branches to improve clarity and reduce complexity. \ No newline at end of file +- Simplifying complex histories: Reorganizing branches to improve clarity and reduce complexity. + +Visit the following resources to learn more: + +- [@official@Git Tools - Rewriting History](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History) +- [@article@Methods of Rewriting History in Git](https://www.atlassian.com/git/tutorials/rewriting-history) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md b/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md index 7eff0dcfd..5f0e98a7a 100644 --- a/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md +++ b/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md @@ -1,8 +1,8 @@ # Roadmaps -GitHub roadmaps are a feature that helps you visualize and organize plans for your projects, allowing you to create a high-level view of milestones and goals, and collaborate on planning and tracking progress with team members. +GitHub Roadmaps are a feature that helps you visualize and organize plans for your projects, allowing you to create a high-level view of milestones and goals, and collaborate on planning and tracking progress with team members. Visit the following resources to learn more: -- [@official@Customizing the roadmap layout](https://docs.github.com/en/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout) +- [@official@Customizing the Roadmap Layout](https://docs.github.com/en/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout) - [@video@Learn how to use Project Roadmaps - GitHub Checkout](https://www.youtube.com/watch?v=D80u__nYYWw) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md b/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md index b6d8f5d51..5954e42af 100644 --- a/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md +++ b/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md @@ -3,4 +3,9 @@ In Git, submodules allow you to include another repository within a project. This feature enables the management of external dependencies as part of the main project. - Including external repositories: Submodules can be used to include other Git repositories within your project. -- Managing dependencies: They provide a way to manage and track changes in external dependencies. \ No newline at end of file +- Managing dependencies: They provide a way to manage and track changes in external dependencies. + +Visit the following resources to learn more: + +- [@official@Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) +- [@article@Git Submodules Tutorial](https://www.atlassian.com/git/tutorials/git-submodule) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md b/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md index 5bcce457e..4b083237f 100644 --- a/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md +++ b/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md @@ -8,5 +8,5 @@ GitHub Organizations allow you to create teams within your organization, which h Visit the following resources to learn more: -- [@offiicial@Organizing members into teams](https://docs.github.com/en/organizations/organizing-members-into-teams) -- [@article@Best practices for organizations and teams using GitHub Enterprise Cloud](https://github.blog/enterprise-software/devops/best-practices-for-organizations-and-teams-using-github-enterprise-cloud/) \ No newline at end of file +- [@official@Organizing Members into Teams](https://docs.github.com/en/organizations/organizing-members-into-teams) +- [@article@Best Practices for Organizations and Teams using GitHub Enterprise Cloud](https://github.blog/enterprise-software/devops/best-practices-for-organizations-and-teams-using-github-enterprise-cloud/) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md b/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md index 93ba8ed51..dc27055f3 100644 --- a/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md +++ b/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md @@ -3,4 +3,10 @@ If mistakes or unwanted changes have been committed to your Git repository, there are ways to correct them. Two common methods for reverting changes include: - Git Reset: Resets the branch to a previous commit. -- Git Revert: Creates a new commit that reverts specified changes. \ No newline at end of file +- Git Revert: Creates a new commit that reverts specified changes. + +Visit the following resources to learn more: + +- [@official@Undoing Changes](https://git-scm.com/book/en/v2/Git-Tools-Reset-Demystified) +- [@article@Undo Anything in Git](https://github.blog/open-source/git/how-to-undo-almost-anything-with-git/) +- [@article@Undoing Changes in Git](https://www.atlassian.com/git/tutorials/undoing-changes) diff --git a/src/data/roadmaps/git-github/content/usecases@PUnYNBrAZWoZiopjtNgnA.md b/src/data/roadmaps/git-github/content/usecases@PUnYNBrAZWoZiopjtNgnA.md index ae3f76750..188596c58 100644 --- a/src/data/roadmaps/git-github/content/usecases@PUnYNBrAZWoZiopjtNgnA.md +++ b/src/data/roadmaps/git-github/content/usecases@PUnYNBrAZWoZiopjtNgnA.md @@ -13,8 +13,6 @@ GitHub Actions offer a wide range of automation possibilities for your developme 9. Cross-platform Testing: Test your code on multiple operating systems and environments simultaneously. 10. Release Management: Automate the creation of release notes and asset uploads for new versions. -These use cases demonstrate how GitHub Actions can streamline your development process, improve code quality, and increase productivity. - Learn more from the following resources: - [@official@GitHub Actions Documentation](https://docs.github.com/en/actions) diff --git a/src/data/roadmaps/git-github/content/viewing-diffs@-0zQvCHG8jS_ghSjmTeIx.md b/src/data/roadmaps/git-github/content/viewing-diffs@-0zQvCHG8jS_ghSjmTeIx.md index c9265ced3..a0255b230 100644 --- a/src/data/roadmaps/git-github/content/viewing-diffs@-0zQvCHG8jS_ghSjmTeIx.md +++ b/src/data/roadmaps/git-github/content/viewing-diffs@-0zQvCHG8jS_ghSjmTeIx.md @@ -1,3 +1,8 @@ # Viewing Diffs -Viewing diffs in Git is crucial for understanding the changes made to your code. This is especially important when collaborating with others or reviewing your own work over time. Diffs show you exactly what lines have been added, modified, or removed between different versions of your files. This feature helps in code review processes, troubleshooting issues, and maintaining a clear history of your project's evolution. Git provides various commands and tools to view these differences, making it easier to track and manage changes effectively. \ No newline at end of file +Viewing diffs in Git is crucial for understanding the changes made to your code. This is especially important when collaborating with others or reviewing your own work over time. Diffs show you exactly what lines have been added, modified, or removed between different versions of your files. This feature helps in code review processes, troubleshooting issues, and maintaining a clear history of your project's evolution. Git provides various commands and tools to view these differences, making it easier to track and manage changes effectively. + +Visit the following resources to learn more: + +- [@official@Git Diff Documentation](https://git-scm.com/docs/git-diff) +- [@article@Git Diff](https://www.atlassian.com/git/tutorials/saving-changes/git-diff) diff --git a/src/data/roadmaps/git-github/content/what-and-why-use@d0-u_-_vtPK8tnUpnj_NB.md b/src/data/roadmaps/git-github/content/what-and-why-use@d0-u_-_vtPK8tnUpnj_NB.md index 91115cf87..1b446e61b 100644 --- a/src/data/roadmaps/git-github/content/what-and-why-use@d0-u_-_vtPK8tnUpnj_NB.md +++ b/src/data/roadmaps/git-github/content/what-and-why-use@d0-u_-_vtPK8tnUpnj_NB.md @@ -2,14 +2,16 @@ Git submodules are a feature that allows you to include one Git repository within another. They are useful for managing external dependencies or shared components across projects. -Key points: +## Key points + 1. Separate repositories with independent histories 2. Parent repository tracks specific submodule commits 3. Enables code reuse and modular project structure 4. Helps manage dependencies and keep main repository focused 5. Facilitates collaboration on complex projects -Benefits: +## Benefits + - Including third-party libraries - Sharing common code - Managing multi-component projects diff --git a/src/data/roadmaps/git-github/content/working-in-a-team@yMx3LdadPz4g25CL3N8da.md b/src/data/roadmaps/git-github/content/working-in-a-team@yMx3LdadPz4g25CL3N8da.md index 978c28a87..7a5d5745a 100644 --- a/src/data/roadmaps/git-github/content/working-in-a-team@yMx3LdadPz4g25CL3N8da.md +++ b/src/data/roadmaps/git-github/content/working-in-a-team@yMx3LdadPz4g25CL3N8da.md @@ -2,4 +2,9 @@ Working in a team on GitHub involves collaborative development using Git's distributed version control system. Team members can work on separate branches, create pull requests for code reviews, and merge changes into the main codebase. GitHub's features like issues, projects, and discussions facilitate communication and project management. Effective teamwork on GitHub requires clear communication, adherence to agreed-upon workflows, and proper use of Git commands to manage code changes and resolve conflicts. This collaborative approach enables teams to work efficiently on complex projects, maintain code quality, and track progress effectively. -GitHub also offers an organization and team management interface, allowing teams to manage projects, members, and collaboration settings. \ No newline at end of file +GitHub also offers an organization and team management interface, allowing teams to manage projects, members, and collaboration settings. + +Learn more from the following resources: + +- [@official@Getting Started with Teams](https://docs.github.com/en/get-started/onboarding/getting-started-with-github-team) +- [@official@Github Team Docs](https://docs.github.com/organizations/organizing-members-into-teams/about-teams) diff --git a/src/data/roadmaps/git-github/content/yaml-syntax@p6rq3lQ9YRrTqwcc31O23.md b/src/data/roadmaps/git-github/content/yaml-syntax@p6rq3lQ9YRrTqwcc31O23.md index ce9bb9ca1..9fd8d6104 100644 --- a/src/data/roadmaps/git-github/content/yaml-syntax@p6rq3lQ9YRrTqwcc31O23.md +++ b/src/data/roadmaps/git-github/content/yaml-syntax@p6rq3lQ9YRrTqwcc31O23.md @@ -21,5 +21,7 @@ Understanding YAML syntax is crucial for working with modern development tools, Learn more from the following resources: +- [@official@YAML](https://yaml.org/) +- [@article@YAML Cheatsheet](https://cheatsheets.zip/yaml) - [@article@What is YAML?](https://circleci.com/blog/what-is-yaml-a-beginner-s-guide/) - [@article@YAML Tutorial : A Complete Language Guide with Examples](https://spacelift.io/blog/yaml)