Improved Git-Github Roadmap (#7218)

Cleaned spelling and grammatical issues in topics. Added new, official links to docs etc.

---------

Co-authored-by: dsh <daniel.s.holdsworth@gmail.com>
pull/7221/head
Vedansh 2 months ago committed by GitHub
parent 3786c91d71
commit b265da3b37
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 1
      src/data/roadmaps/git-github/content/caching-dependencies@HMNhzzV6ApTKj4I_FOmUB.md
  2. 6
      src/data/roadmaps/git-github/content/cherry-picking-commits@eFf2fesrs-1aVM5tH3ORQ.md
  3. 2
      src/data/roadmaps/git-github/content/clean-git-history@i3AbARgzQtxtlB-1AS8zv.md
  4. 9
      src/data/roadmaps/git-github/content/cloning-repositories@1Koej79yTv-OAswVZwgGq.md
  5. 1
      src/data/roadmaps/git-github/content/code-reviews@xLB2fhsOm0Vu3xg_PusJB.md
  6. 2
      src/data/roadmaps/git-github/content/collaboration@bXfCUG3h1TIFPgD4WUDph.md
  7. 2
      src/data/roadmaps/git-github/content/contribution-guidelines@pJ-najh7dXhhYA_0bDiR5.md
  8. 2
      src/data/roadmaps/git-github/content/creating-account@i7fIIHcBEk473te8bniJ5.md
  9. 2
      src/data/roadmaps/git-github/content/custom-domains@VdoxEWaU56-QCbHFRw649.md
  10. 2
      src/data/roadmaps/git-github/content/deploying-static-websites@ZHplGidvhxEIC3HN8KqRa.md
  11. 1
      src/data/roadmaps/git-github/content/git-log-options@qFEonbCMLri8iA0yONwuf.md
  12. 2
      src/data/roadmaps/git-github/content/git-remotes@aWx9WHUrgofcTr8B-fQYe.md
  13. 2
      src/data/roadmaps/git-github/content/git-reset@igrR7LguU1jemg_mf_AD6.md
  14. 2
      src/data/roadmaps/git-github/content/github-actions@AmetdCURXXob5TUsikAab.md
  15. 4
      src/data/roadmaps/git-github/content/github-api@NV2HAXLEN7tskfgyFrbaf.md
  16. 2
      src/data/roadmaps/git-github/content/github-cli@h9cf_dh_pwjialOXOlNW-.md
  17. 2
      src/data/roadmaps/git-github/content/github-discussions@snWQHCQECZyUXHdn6ppIk.md
  18. 5
      src/data/roadmaps/git-github/content/github-essentials@NeSvgS2yA5x8qbcJHrV__.md
  19. 4
      src/data/roadmaps/git-github/content/github-gists@M2_hBvXou7cCNqsMnexCt.md
  20. 2
      src/data/roadmaps/git-github/content/github-pages@bnai6R6pOq_L5CPdbVwMW.md
  21. 2
      src/data/roadmaps/git-github/content/github-security@f2PG4t6iVtfIH8BVe5H7f.md
  22. 2
      src/data/roadmaps/git-github/content/installation-and-setup@vHfpoVbOW0DHNtiy0VN4X.md
  23. 4
      src/data/roadmaps/git-github/content/mentions@oWMaOWU06juoIuzXNe-wt.md
  24. 5
      src/data/roadmaps/git-github/content/merge-strategies@0rHDUbAdXqH9zQW2VfJ8v.md
  25. 2
      src/data/roadmaps/git-github/content/pr-guidelines@GwDNk2HBjASr_NWIL4G3-.md
  26. 1
      src/data/roadmaps/git-github/content/pre-push@j5kWEUKwBFg5EMm8-61K9.md
  27. 3
      src/data/roadmaps/git-github/content/profile-readme@KbVvFVQ4k77R2_ddsc7WT.md
  28. 2
      src/data/roadmaps/git-github/content/pushing--pulling-changes@ZVMCh9om37ee1qsecFa-N.md
  29. 2
      src/data/roadmaps/git-github/content/renaming-branch@_dPOVUbxApx0pfKPH8fgr.md
  30. 5
      src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md
  31. 4
      src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md
  32. 5
      src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md
  33. 4
      src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md
  34. 6
      src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md
  35. 2
      src/data/roadmaps/git-github/content/usecases@PUnYNBrAZWoZiopjtNgnA.md
  36. 5
      src/data/roadmaps/git-github/content/viewing-diffs@-0zQvCHG8jS_ghSjmTeIx.md
  37. 6
      src/data/roadmaps/git-github/content/what-and-why-use@d0-u_-_vtPK8tnUpnj_NB.md
  38. 5
      src/data/roadmaps/git-github/content/working-in-a-team@yMx3LdadPz4g25CL3N8da.md
  39. 2
      src/data/roadmaps/git-github/content/yaml-syntax@p6rq3lQ9YRrTqwcc31O23.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

@ -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)

@ -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)

@ -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)

@ -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.

@ -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:

@ -4,7 +4,7 @@ Contribution guidelines are essential for collaborative projects on GitHub as th
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/)

@ -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)

@ -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)

@ -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)

@ -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.

@ -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)

@ -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)

@ -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)
- [@video@What are Github Actions](https://www.youtube.com/watch?v=URmeTqglS58)

@ -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)

@ -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,5 +4,5 @@ GitHub Discussions is a collaborative communication feature within GitHub reposi
Visit the following resources to learn more:
- [@official@GitHub Discussions Docs](https://docs.github.com/en/discussions)
- [@video@What is GitHub Discussions?](https://www.youtube.com/watch?v=bErGYN3Ljz8)
- [@official@official GitHub Discussions Docs](https://docs.github.com/en/discussions)

@ -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.
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)

@ -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)

@ -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)

@ -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)

@ -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)

@ -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.
Visit the following resources to learn more:
- [@official@Mention Somebody](https://github.blog/news-insights/mention-somebody-they-re-notified/)

@ -7,3 +7,8 @@ When combining changes from one branch into another, Git provides various merge
- Rebase
- Squash
- 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)

@ -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/)

@ -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)

@ -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)

@ -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)
- [@article@Git Push and Pull Tutorial](https://www.datacamp.com/tutorial/git-push-pull)

@ -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/)

@ -12,3 +12,8 @@ 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.
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)

@ -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)

@ -4,3 +4,8 @@ In Git, submodules allow you to include another repository within a project. Thi
- 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.
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)

@ -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/)
- [@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/)

@ -4,3 +4,9 @@ If mistakes or unwanted changes have been committed to your Git repository, ther
- Git Reset: Resets the branch to a previous commit.
- 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)

@ -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)

@ -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.
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)

@ -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

@ -3,3 +3,8 @@
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.
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)

@ -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)

Loading…
Cancel
Save