From 8350ed53c730a3415c981ce2127bc2023f1c69e6 Mon Sep 17 00:00:00 2001 From: Obiechina Emmanuel <94564639+chibuike-19@users.noreply.github.com> Date: Tue, 13 Aug 2024 19:01:25 +0100 Subject: [PATCH] Chibuike 19/add git and github contents (#6551) * Added content to custom-validators topic * Added contents to 10 git & github topics * Apply suggestions from code review styling clean up --------- Co-authored-by: dsh --- .../checkout-branch@PtRo-wGiNAagZ6CykfvMr.md | 10 +++++++++- .../checkout-tags@62E1tDMXB6K74OEN0WsS0.md | 10 +++++++++- ...rry-picking-commits@eFf2fesrs-1aVM5tH3ORQ.md | 10 +++++++++- .../clean-git-history@i3AbARgzQtxtlB-1AS8zv.md | 14 +++++++++++++- ...ent-vs-server-hooks@zsU6R2zvJKnYNU2ac4o4p.md | 10 +++++++++- ...loning-repositories@1Koej79yTv-OAswVZwgGq.md | 10 +++++++++- .../code-reviews@xLB2fhsOm0Vu3xg_PusJB.md | 17 ++++++++++++++++- ...aboration-on-github@d_GNnB6PBINz1jxGNWAE-.md | 10 +++++++++- .../collaborators@r-u1vTpUyuvsB0revOU0C.md | 13 ++++++++++++- .../commit-messages@7lRUYWNSpHvJ-QyIE8RMa.md | 12 +++++++++++- 10 files changed, 106 insertions(+), 10 deletions(-) diff --git a/src/data/roadmaps/git-github/content/checkout-branch@PtRo-wGiNAagZ6CykfvMr.md b/src/data/roadmaps/git-github/content/checkout-branch@PtRo-wGiNAagZ6CykfvMr.md index 0735a949d..4c36dafd4 100644 --- a/src/data/roadmaps/git-github/content/checkout-branch@PtRo-wGiNAagZ6CykfvMr.md +++ b/src/data/roadmaps/git-github/content/checkout-branch@PtRo-wGiNAagZ6CykfvMr.md @@ -1 +1,9 @@ -# Checkout Branch \ No newline at end of file +# Checkout Branch + +In Git, to "checkout" from a branch means to switch your working directory to that branch, making it the active branch. This updates your files to match the state of that branch and allows you to work on it. + +Learn more from the following resources: + +- [@official@git-checkout](https://git-scm.com/docs/git-checkout) +- [@article@git-commands-checkout](https://www.git-tower.com/learn/git/commands/git-checkout) +- [@video@Git Checkout. Different ways of using the checkout command in the Git Project](https://youtu.be/h_PIHOFUYuw?si=tebKCCb5U3ues0Io) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/checkout-tags@62E1tDMXB6K74OEN0WsS0.md b/src/data/roadmaps/git-github/content/checkout-tags@62E1tDMXB6K74OEN0WsS0.md index 08a613336..3c6c1fc92 100644 --- a/src/data/roadmaps/git-github/content/checkout-tags@62E1tDMXB6K74OEN0WsS0.md +++ b/src/data/roadmaps/git-github/content/checkout-tags@62E1tDMXB6K74OEN0WsS0.md @@ -1 +1,9 @@ -# Checkout Tags \ No newline at end of file +# Checkout Tags + +Tags in Git are typically used to mark specific points in history, such as a release version. Checking out a tag means switching your working directory to the state of the repository at the point in time when that tag was created. + +Learn more from the following resources: + +- [@article@How To Checkout Git Tags](https://devconnected.com/how-to-checkout-git-tags/) +- [@article@What is git tag, How to create tags & How to checkout git remote tag(s)](https://stackoverflow.com/questions/35979642/what-is-git-tag-how-to-create-tags-how-to-checkout-git-remote-tags) +- [@video@Git Tag Tutorial | Create, Checkout, and Delete Git Tags | Learn Git](https://youtu.be/spkUevg1NqM?si=UXRwJEOI6bpN30nM) \ No newline at end of file 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 cb49d81a5..c6273ecb8 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 @@ -1 +1,9 @@ -# Cherry Picking Commits \ No newline at end of file +# Cherry Picking Commits + +Cherry-picking in Git allows you to apply a specific commit from one branch to another, without merging the entire branch. This is useful when you want to bring in a specific feature or fix from one branch to another without incorporating all the changes from the source branch. + +Learn more from the following resources: + +- [@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 b3fdb3113..2e4b1432e 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 +1,13 @@ -# Clean Git History \ No newline at end of file +# 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: + +- 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 +- To be able to deploy any commit on your development branch using your CI/CD system +- If you are handling mobile app releases and you are responsible for figuring out what feature is in which release. + +Learn more from the following resources: + +- [@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 diff --git a/src/data/roadmaps/git-github/content/client-vs-server-hooks@zsU6R2zvJKnYNU2ac4o4p.md b/src/data/roadmaps/git-github/content/client-vs-server-hooks@zsU6R2zvJKnYNU2ac4o4p.md index 536e36b6d..7c3f165ab 100644 --- a/src/data/roadmaps/git-github/content/client-vs-server-hooks@zsU6R2zvJKnYNU2ac4o4p.md +++ b/src/data/roadmaps/git-github/content/client-vs-server-hooks@zsU6R2zvJKnYNU2ac4o4p.md @@ -1 +1,9 @@ -# Client vs Server Hooks \ No newline at end of file +# Client vs Server Hooks + +Like many other Version Control Systems, Git has a way to fire off custom scripts when certain important actions occur. There are two groups of these hooks: client-side and server-side. Client-side hooks are triggered by operations such as committing and merging, while server-side hooks run on network operations such as receiving pushed commits. + +Learn more from the following resources: + +- [@official@Git Hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks#:~:text=There%20are%20two%20groups%20of,for%20all%20sorts%20of%20reasons.) +- [@article@Git Hooks: The Powerful Tool You're Probably Not Using](https://dev.to/algodame/git-hooks-the-powerful-tool-youre-probably-not-using-but-should-be-1lec) +- [@video@Client vs Server Hooks](https://youtu.be/egfuwOe8nXc?si=IkbLCr-3eGE9x6cY) 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 cb4ff2edb..9d30a35b5 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 +1,9 @@ -# Cloning Repositories \ No newline at end of file +# 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. + +Learn more from the following resources: + +- [@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) 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 027acdfe8..791d9cf89 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 @@ -1 +1,16 @@ -# Code Reviews \ No newline at end of file +# Code Reviews + + +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. +- Boost collaboration, communication, and knowledge sharing among developers by providing a forum to discuss code and ask questions, share ideas and best practices, and learn from each other. +- Ensure that the code is maintainable by identifying any software maintenance issues and suggesting improvements. + +Learn more from the following links: + +- [@article@A practical guide for better, faster code reviews](https://github.com/mawrkus/pull-request-review-guide) +- [@article@How to improve code with code reviews](https://github.com/resources/articles/software-development/how-to-improve-code-with-code-reviews) diff --git a/src/data/roadmaps/git-github/content/collaboration-on-github@d_GNnB6PBINz1jxGNWAE-.md b/src/data/roadmaps/git-github/content/collaboration-on-github@d_GNnB6PBINz1jxGNWAE-.md index 1211e59ad..442350452 100644 --- a/src/data/roadmaps/git-github/content/collaboration-on-github@d_GNnB6PBINz1jxGNWAE-.md +++ b/src/data/roadmaps/git-github/content/collaboration-on-github@d_GNnB6PBINz1jxGNWAE-.md @@ -1 +1,9 @@ -# Collaboration on GitHub \ No newline at end of file +# Collaboration on GitHub + +Collaboration on GitHub is a powerful way for multiple people to work together on the same project, using Git as the version control system. GitHub provides various tools and workflows that make collaboration efficient and organized. + +Learn more from the following resources: + +- [@official@How to collaborate in a GitHub project](https://gist.github.com/neklaf/9002d3acccf6b6e448db5c4c4e8764c0) +- [@article@Best Practices for collaborating in github](https://www.gitkraken.com/blog/collaborate-on-github) +- [@article@Working with GitHub in VS Code](https://code.visualstudio.com/docs/sourcecontrol/github) diff --git a/src/data/roadmaps/git-github/content/collaborators@r-u1vTpUyuvsB0revOU0C.md b/src/data/roadmaps/git-github/content/collaborators@r-u1vTpUyuvsB0revOU0C.md index 86852d69f..2fb5a3e7b 100644 --- a/src/data/roadmaps/git-github/content/collaborators@r-u1vTpUyuvsB0revOU0C.md +++ b/src/data/roadmaps/git-github/content/collaborators@r-u1vTpUyuvsB0revOU0C.md @@ -1 +1,12 @@ -# Collaborators \ No newline at end of file +# Collaborators + +Collaborators in GitHub are users who have been granted direct access to a repository by the repository owner or organization administrators. Collaborators can perform actions like pushing commits, creating branches, and managing issues or pull requests, depending on the permissions granted to them. They are typically added to private repositories or to public repositories where more control over contributions is needed. + +Learn more from the following resources: + +- [@official@How to add collaborators to your personal projects](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository) +- [@official@Adding outside collaborators to repositories in your organization](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization) +- [@article@What are github collaborators](https://www.geeksforgeeks.org/what-are-github-collaborators/) +- [@article@How to Add Collaborators to Your GitHub Repository](https://www.blinkops.com/blog/how-to-add-collaborators-to-your-github-repository) +- [@video@Using Github for Team collaboration](https://youtu.be/4nyIS58ORWw?si=yK5LCONNVm9OIUK5) + diff --git a/src/data/roadmaps/git-github/content/commit-messages@7lRUYWNSpHvJ-QyIE8RMa.md b/src/data/roadmaps/git-github/content/commit-messages@7lRUYWNSpHvJ-QyIE8RMa.md index cfa90cc43..dcd1abf0f 100644 --- a/src/data/roadmaps/git-github/content/commit-messages@7lRUYWNSpHvJ-QyIE8RMa.md +++ b/src/data/roadmaps/git-github/content/commit-messages@7lRUYWNSpHvJ-QyIE8RMa.md @@ -1 +1,11 @@ -# Commit Messages \ No newline at end of file +# Commit Messages + +A Git commit message is a brief explanation of the changes introduced in a particular commit. It helps others (and your future self) understand the purpose of the changes and the context behind them. Writing clear and informative commit messages is an important practice for maintaining a well-organized and easily navigable project history. + +Learn more from the following resources: + +- [@article@How to Write Better Git Commit Messages](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/) +- [@article@Writing good commit messages](https://www.theodinproject.com/lessons/foundations-commit-messages) +- [@article@How to Write Good Git Commit Messages like a pro](https://medium.com/front-end-weekly/how-to-write-good-git-commit-messages-like-a-pro-2c12f01569d9) +- [@video@Write git commit messages like a PRO with Conventional Commits](https://youtu.be/OJqUWvmf4gg?si=Fgl3isZpP13jYXHP) +- [@video@How to Make Actually Good Commits in Git](https://youtu.be/Dy5t_H2PRrk?si=0V-JEbqphpJX5OLl) \ No newline at end of file