From a5280e0cd43cd211d438e17a7f38e56819ee75b5 Mon Sep 17 00:00:00 2001 From: sfxtomoniyi Date: Thu, 17 Apr 2025 12:47:20 +0100 Subject: [PATCH 1/5] PLAT-938 feat: just a new file this is a test --- test_folder/hello.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 test_folder/hello.md diff --git a/test_folder/hello.md b/test_folder/hello.md new file mode 100644 index 0000000..e69de29 From 6ef919e04d96dcec80940680d0b73385ddd3b1a2 Mon Sep 17 00:00:00 2001 From: sfxtomoniyi Date: Thu, 17 Apr 2025 16:11:58 +0100 Subject: [PATCH 2/5] PLAT-938 feat: added intern-guide.md --- docs/intern-guide.md | 84 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 docs/intern-guide.md diff --git a/docs/intern-guide.md b/docs/intern-guide.md new file mode 100644 index 0000000..6bef78c --- /dev/null +++ b/docs/intern-guide.md @@ -0,0 +1,84 @@ +# Key Git Concepts + +Here are some some fundamental Git concepts that will help you navigate your workflow more efficiently. + +## Staging + +Staging is the process of selecting which changes you want to include in your next commit. Git allows you to stage individual files or all changes at once. When you stage changes, they are marked as "staged" in your Git status. You also have the option of using the source control panel on your VS code interface but learning the terminal code is important if you are running your code on a VM or only have access to a shell interface + +**Tips:** + +* Use `git add ` to stage individual files. +* Use `git add .` to stage all changes in your current directory and subdirectories. +* Use `git reset ` to unstage a specific file. + +**Common mistakes:** + +* Forgetting to stage changes before committing. +* Staging changes that shouldn't be committed (e.g. sensitive data). + +**Useful commands:** + +* `git status` to view which files are staged. +* `git diff --staged` to view the exact changes being staged. + +## Branching + +Branching is a way to isolate changes from the main codebase. It allows you to work on new features or bug fixes without affecting the main codebase. + +**Tips:** + +* Use `git branch ` to create a new branch. +* Use `git checkout ` to switch to a different branch. +* Use `git merge ` to merge changes from another branch. + +**Common mistakes:** + +* Forgetting to switch to the correct branch before making changes. +* Merging changes without resolving conflicts. + +**Useful commands:** + +* `git branch` to view all branches. +* `git log --graph` to view a visual representation of your commit history. + +## Committing + +Committing is the process of saving your changes to the local repository. Commits should be descriptive and contain a clear message explaining the changes made e.g feat: added bcrypt package. + +**Tips:** + +* Use `git commit -m ""` to commit changes with a descriptive message. +* Use `git commit -a` to commit all changes in your current directory and subdirectories. +* Use `git commit --amend` to edit the most recent commit message. + +**Common mistakes:** + +* Not including a descriptive commit message. +* Committing sensitive data (e.g. passwords). + +**Useful commands:** + +* `git log` to view a list of all commits. +* `git show ` to view the exact changes made in a specific commit. +* use a .gitignore file and a .env file to avoid pushing sensitive data to github. +* use a .env to house sensitive data like connection strings, passwords or api keys. + +## Pushing and Pulling + +Pushing is the process of uploading your local changes to a remote repository. Pulling is the process of downloading changes from a remote repository to your local machine. + +**Tips:** + +* Use `git push` to push your local changes to a remote repository. +* Use `git pull` to pull changes from a remote repository. + +**Common mistakes:** + +* Forgetting to pull changes before pushing. +* Pushing changes to the wrong branch. + +**Useful commands:** + +* `git remote -v` to view the URLs of your remote repositories. +* `git fetch` to download changes from a remote repository without merging. From 575b665138fd29bc5f98afb2f10fe35bf2cc9a30 Mon Sep 17 00:00:00 2001 From: sfxtomoniyi Date: Fri, 25 Apr 2025 13:16:52 +0100 Subject: [PATCH 3/5] feat: Added a message to the hello.md file --- hello.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 hello.md diff --git a/hello.md b/hello.md new file mode 100644 index 0000000..2a25615 --- /dev/null +++ b/hello.md @@ -0,0 +1 @@ +### This is a welcome message \ No newline at end of file From 066d0fe9cb956647c9d9869d744a721bdd57a977 Mon Sep 17 00:00:00 2001 From: sfxtomoniyi Date: Fri, 25 Apr 2025 13:25:25 +0100 Subject: [PATCH 4/5] Revert "feat: Added a message to the hello.md file" This reverts commit 575b665138fd29bc5f98afb2f10fe35bf2cc9a30. --- hello.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 hello.md diff --git a/hello.md b/hello.md deleted file mode 100644 index 2a25615..0000000 --- a/hello.md +++ /dev/null @@ -1 +0,0 @@ -### This is a welcome message \ No newline at end of file From e499e45d4d92dd87addad778f8e613b24f43b536 Mon Sep 17 00:00:00 2001 From: sfxtomoniyi Date: Fri, 25 Apr 2025 13:30:06 +0100 Subject: [PATCH 5/5] feat: added a line in the intern-guide --- docs/intern-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/intern-guide.md b/docs/intern-guide.md index 6bef78c..4d9fbec 100644 --- a/docs/intern-guide.md +++ b/docs/intern-guide.md @@ -72,6 +72,7 @@ Pushing is the process of uploading your local changes to a remote repository. P * Use `git push` to push your local changes to a remote repository. * Use `git pull` to pull changes from a remote repository. +* Use `git revert ` to undo changes from a specific commit while preserving the commit history. **Common mistakes:** @@ -82,3 +83,4 @@ Pushing is the process of uploading your local changes to a remote repository. P * `git remote -v` to view the URLs of your remote repositories. * `git fetch` to download changes from a remote repository without merging. +