+ +### 3. Choose branches to compare + +You’ll see two dropdowns: + +- **base:** usually `main` (where you want your changes to go) +- **compare:** your feature branch (the one containing your new commits) + +Example: + +``` +base: main ← compare: feature/add-readme +``` + +### 4. Write a clear pull request title and description + +Add a meaningful title and a short description of your changes. + +Example: + +**Title:** +`Added a detailed README with setup instructions` + +**Description:** + +``` +### What’s new +* Added a comprehensive README file +*-* Included setup, usage, and contribution guide + +### Why +To help new contributors get started quickly. +``` + +This helps reviewers understand your contribution at a glance. + +### 5. Review your changes + +Scroll down to see all the files changed. Make sure your commits reflect what you actually want to merge — and nothing extra. + +### 6. Create the Pull Request + +Click on **Create Pull Request** 🎉 Your PR is now open! + +It will appear under the repository’s **Pull Requests** tab, where reviewers can: + +- Comment on your changes +- Suggest edits +- Approve or request modifications + +
+ +## 7. Review Process + +Once you submit your PR: + +- Reviewers may leave comments asking for clarification or improvements +- You can make more commits to your branch, and they’ll automatically appear in the same PR +- When everything looks good, the maintainer will **merge** your PR into the base branch + +## 8. Merge the Pull Request + +Once approved, the PR can be merged. If you have permission, click: + +> **Merge Pull Request** → **Confirm Merge** + +After merging, delete your branch to keep the repository clean: + +```bash +git branch -d feature/add-readme +``` + +## Example Workflow Summary + +```bash +# Create a new branch +git checkout -b feature/add-readme + +# Make changes +git add . +git commit -m "Added detailed README" + +# Push to GitHub +git push origin feature/add-readme + +# Open PR on GitHub website +# base: main ← compare: feature/add-readme +``` + +## Best Practices for Pull Requests + +* Keep PRs small and focused — easier to review +* Write clear titles and meaningful commit messages +* Add screenshots if your change affects the UI +* Reference related issues using `Fixes #issue-number` +* Respond to review comments promptly + +
+ +## Summary + +You’ve learned how to: + +* Understand what a Pull Request is +* Create and open a PR on GitHub +* Write a good title and description +* Collaborate and merge your changes + +--- + +Need help? Ask your questions or share your first PR experience in the [GitHub Discussions](https://github.com/orgs/codeharborhub/discussions/categories/introduction-to-github). We’d love to hear from you and help you grow as a contributor \ No newline at end of file diff --git a/docs/github/img-1.png b/docs/github/img-1.png new file mode 100644 index 0000000..a8eb589 Binary files /dev/null and b/docs/github/img-1.png differ diff --git a/docs/github/img-10.png b/docs/github/img-10.png new file mode 100644 index 0000000..5f6dbbe Binary files /dev/null and b/docs/github/img-10.png differ diff --git a/docs/github/img-11.png b/docs/github/img-11.png new file mode 100644 index 0000000..2305e64 Binary files /dev/null and b/docs/github/img-11.png differ diff --git a/docs/github/img-12.png b/docs/github/img-12.png new file mode 100644 index 0000000..53d8dbe Binary files /dev/null and b/docs/github/img-12.png differ diff --git a/docs/github/img-13.png b/docs/github/img-13.png new file mode 100644 index 0000000..0971725 Binary files /dev/null and b/docs/github/img-13.png differ diff --git a/docs/github/img-14.png b/docs/github/img-14.png new file mode 100644 index 0000000..39fd27d Binary files /dev/null and b/docs/github/img-14.png differ diff --git a/docs/github/img-15.png b/docs/github/img-15.png new file mode 100644 index 0000000..9ea85b6 Binary files /dev/null and b/docs/github/img-15.png differ diff --git a/docs/github/img-16.png b/docs/github/img-16.png new file mode 100644 index 0000000..588ea44 Binary files /dev/null and b/docs/github/img-16.png differ diff --git a/docs/github/img-17.png b/docs/github/img-17.png new file mode 100644 index 0000000..e43acf8 Binary files /dev/null and b/docs/github/img-17.png differ diff --git a/docs/github/img-2.png b/docs/github/img-2.png new file mode 100644 index 0000000..5ec3f0d Binary files /dev/null and b/docs/github/img-2.png differ diff --git a/docs/github/img-3.png b/docs/github/img-3.png new file mode 100644 index 0000000..2647eb0 Binary files /dev/null and b/docs/github/img-3.png differ diff --git a/docs/github/img-4.png b/docs/github/img-4.png new file mode 100644 index 0000000..5c52bcf Binary files /dev/null and b/docs/github/img-4.png differ diff --git a/docs/github/img-5.png b/docs/github/img-5.png new file mode 100644 index 0000000..7092f06 Binary files /dev/null and b/docs/github/img-5.png differ diff --git a/docs/github/img-6.png b/docs/github/img-6.png new file mode 100644 index 0000000..2089397 Binary files /dev/null and b/docs/github/img-6.png differ diff --git a/docs/github/img-7.png b/docs/github/img-7.png new file mode 100644 index 0000000..8f42760 Binary files /dev/null and b/docs/github/img-7.png differ diff --git a/docs/github/img-8.png b/docs/github/img-8.png new file mode 100644 index 0000000..62957e1 Binary files /dev/null and b/docs/github/img-8.png differ diff --git a/docs/github/img-9.png b/docs/github/img-9.png new file mode 100644 index 0000000..f3bb5e3 Binary files /dev/null and b/docs/github/img-9.png differ diff --git a/docs/github/introduction-to-github.md b/docs/github/introduction-to-github.md new file mode 100644 index 0000000..dde8a92 --- /dev/null +++ b/docs/github/introduction-to-github.md @@ -0,0 +1,45 @@ +--- +id: introduction-to-github +title: Introduction to GitHub +sidebar_label: Introduction to GitHub +sidebar_position: 1 +description: "Get started with GitHub in less than an hour! Learn the basics of Git and GitHub, create a new repository, clone a repository, create a branch, make changes to a file, commit changes, push changes to GitHub, create a pull request, and merge a pull request." +tags: [github, git, version control, collaboration, open source, beginners] +keywords: [github, git, version control, collaboration, open source, repository, branch, commit, pull request, merge, beginners] +--- + +Welcome to the Introduction to GitHub tutorial! This tutorial is designed to help you get started with GitHub and learn the basics of Git and GitHub. + +
+ +## What you'll learn + +- Create a new repository +- Clone a repository +- Create a branch +- Make changes to a file +- Commit changes +- Push changes to GitHub +- Create a pull request +- Merge a pull request +- And more! + +## Why learn GitHub? + +GitHub is a platform that brings people together to work on projects from all over the world. It is a powerful tool for collaboration, version control, and open-source development. Learning GitHub can help you become a better developer, work on exciting projects, and contribute to the open-source community. + +## Prerequisites + +This tutorial is designed for beginners, so no prior knowledge of Git or GitHub is required. All you need is a GitHub account and a computer with an internet connection. + +## Let's get started! + +Now that you know what to expect from this course, let's get started with the first lesson: [Create a GitHub account](/tutorial/github/create-a-github-account). If you already have a GitHub account, you can skip this step and move on to the next lesson. + +[](https://github.com/new?template_owner=ajay-dhangar&template_name=introduction-to-github&owner=%40me&name=skills-introduction-to-github&description=My+clone+repository&visibility=public) + +Click on the button above to create a new repository and start the tutorial. You can use this repository to follow along with the practice what you learn. + +If you have any questions or need help, feel free to ask in the [GitHub Discussions](https://github.com/orgs/codeharborhub/discussions/categories/introduction-to-github) for this course. We're here to help you succeed! \ No newline at end of file diff --git a/docs/github/make-changes-to-a-file.md b/docs/github/make-changes-to-a-file.md new file mode 100644 index 0000000..cc7a641 --- /dev/null +++ b/docs/github/make-changes-to-a-file.md @@ -0,0 +1,78 @@ +--- +id: make-changes-to-a-file +title: Make Changes to a File +sidebar_label: Make Changes to a File +sidebar_position: 6 +description: Learn how to make changes to a file in a Git repository. Edit files, add new content, and update existing code in your project. +tags: [github, git, version control, collaboration, beginners] +keywords: + [ + github, + git, + version control, + collaboration, + beginners, + open source, + edit, + file, + changes, + update, + content, + ] +--- + +**To make changes to a file in a Git repository, you need to edit the file, add new content, or update existing code. Making changes to files allows you to improve your project, fix bugs, and add new features.** + +
+ +To make changes to a file in a Git repository, follow these steps: + +1. Open the file you want to edit in your code editor. You can use popular code editors like VS Code or any other editor of your choice. + +2. Make the necessary changes to the file. You can add new content, update existing code, fix bugs, or make improvements to the file. + +3. Save the changes to the file. Use the `Save` or `Save As` option in your code editor to save the changes you made. + +4. Verify the changes by reviewing the file. Check if the changes are correct, well-formatted, and meet the requirements of your project. + +5. Stage the changes using the `git add` command. This command adds the changes to the staging area, preparing them for the next commit. + + ```bash title="Terminal" + git add filename + ``` + + :::tip Note: + Replace `filename` with the name of the file you want to stage. You can also use `git add .` to stage all changes in the repository. + ::: + +6. Commit the changes using the `git commit` command. This command creates a new commit with the changes you staged in the previous step. + + ```bash title="Terminal" + git commit -m "Add new feature to the project" + ``` + + :::tip Note: + Replace `"Add new feature to the project"` with a meaningful commit message that describes the changes you made in this commit. + ::: + +
+ +7. Push the changes to GitHub using the `git push` command. This command uploads the commits to the remote repository on GitHub. + + ```bash title="Terminal" + git push origin branch-name + ``` + + :::tip Note: + Replace `branch-name` with the name of the branch you are working on. By default, the branch name is `main` or `master`. + ::: + +8. Verify the changes on GitHub by visiting the repository on the GitHub website. You should see the new commit with the changes you made to the file. + +9. Congratulations! You have successfully made changes to a file in a Git repository and pushed the changes to GitHub. Keep up the good work! + +By following these steps, you can make changes to files in your Git repository, collaborate with others, and contribute to open-source projects. Keep practicing and learning to become a better developer! diff --git a/docs/github/merge-a-pull-request.md b/docs/github/merge-a-pull-request.md new file mode 100644 index 0000000..b9e1db9 --- /dev/null +++ b/docs/github/merge-a-pull-request.md @@ -0,0 +1,152 @@ +--- +id: merge-a-pull-request +title: Merge a Pull Request +sidebar_label: Merge a Pull Request +sidebar_position: 10 +description: "Learn how to merge a pull request (PR) on GitHub after code review, understand different merge methods, and clean up branches after merging." +tags: [github, git, pull request, merge, collaboration, beginners, open source] +keywords: [merge pull request, github merge, git merge, merge branch, github pr workflow, beginners guide] +--- + +After creating and reviewing a **Pull Request (PR)**, the final step in the GitHub workflow is to **merge it** into the main branch. Merging means integrating your feature branch changes into the base branch — typically `main`. + +Once merged, your updates officially become part of the project 🎉 + +
+ +## What Does “Merging” Mean? + +In Git and GitHub, **merging** takes the changes from one branch (like `feature/update-ui`) and integrates them into another branch (like `main`). +When you merge a PR, Git combines the commit histories and updates the target branch with your new code. + +## Step-by-Step: How to Merge a Pull Request + +### 1. Go to the Pull Requests tab + +Navigate to your repository on GitHub and click on the **Pull requests** tab. +You’ll see a list of open PRs. + +Example: +`https://github.com/
+ +### 3. Review the Merge Status + +GitHub automatically checks if the PR can be merged cleanly. +You’ll see one of these messages: + +* ✅ **This branch has no conflicts with the base branch** – safe to merge +* ⚠️ **This branch has conflicts that must be resolved** – fix before merging + +If there are conflicts, click **Resolve conflicts**, fix them in the web editor, and commit the changes. + +### 4. Choose a Merge Method + +GitHub provides three main merge options: + +| Merge Option | Description | When to Use | +|---------------|--------------|--------------| +| **Merge Commit** | Adds all commits from the feature branch into the base branch with a single merge commit | Default, keeps full history | +| **Squash and Merge** | Combines all commits from the branch into one clean commit | Best for small feature updates or fixes | +| **Rebase and Merge** | Rewrites the commit history, placing your commits on top of the base branch | For maintaining a linear history | + +Example (default): + +> ✅ **Merge pull request #3 from feature/add-readme** + +### 5. Confirm the Merge + +Once you’ve chosen a method, click: **Merge Pull Request → Confirm Merge** + +GitHub will integrate your changes and show a success message: + +> 🎉 Pull request successfully merged and closed! + +### 6. Delete the Branch (Optional but Recommended) + +After merging, it’s a good practice to delete your feature branch — it keeps your repository clean. Click **Delete branch** on GitHub or run this locally: + +```bash +git branch -d feature/add-readme +``` + +If you want to delete the remote branch as well: + +```bash +git push origin --delete feature/add-readme +``` + +
+ +## Example Workflow Summary + +Here’s a full merge process from start to finish: + +```bash +# 1. Create a new branch +git checkout -b feature/add-readme + +# 2. Make changes and commit +git add . +git commit -m "Added detailed README file" + +# 3. Push branch to GitHub +git push origin feature/add-readme + +# 4. Create a Pull Request on GitHub +# 5. Review → Merge Pull Request +# 6. Delete the feature branch +``` + +## Troubleshooting Common Merge Issues + +| Problem | Cause | Solution | +|----------|--------|----------| +| Merge conflicts | Both branches edited the same file | Resolve conflicts manually, then commit | +| Accidental merge to wrong branch | Wrong base selected | Revert the PR and recreate with correct base | +| Too many commits | Long commit history | Use “Squash and Merge” for a cleaner log | + +--- + +:::tip + +* Always pull the latest `main` branch before merging +* Use descriptive PR titles for better project history +* Use “Squash and Merge” for small, single-purpose PRs +* Delete merged branches to reduce clutter + +::: + +## Summary + +You’ve learned how to: + +- Review and merge pull requests on GitHub +- Understand merge options (merge, squash, rebase) +- Handle conflicts before merging +- Clean up branches after merging + +This marks the **completion of your GitHub journey** — from creating repositories to collaborating and merging code. + +--- + +**Need help or want to share your first merged PR?** + +Join the [GitHub Discussions](https://github.com/orgs/codeharborhub/discussions/categories/introduction-to-github) community — we’d love to see your progress and support you on your journey \ No newline at end of file diff --git a/docs/github/push-changes-to-github.md b/docs/github/push-changes-to-github.md new file mode 100644 index 0000000..784ed6e --- /dev/null +++ b/docs/github/push-changes-to-github.md @@ -0,0 +1,147 @@ +--- +id: push-changes-to-github +title: Push Changes to GitHub +sidebar_label: Push Changes to GitHub +sidebar_position: 8 +description: "Learn how to push your local commits to a remote repository on GitHub. Understand the difference between local and remote repositories and how to keep them in sync." +tags: [github, git, push, commits, repository, beginners, version control] +keywords: [push changes, github push, git push origin main, remote repository, sync local and remote, beginners guide] +--- + +Once you’ve made and committed changes to your local repository, the next step is to share those updates with your remote repository on **GitHub**. This process is known as **pushing** changes. + +Pushing ensures your latest work is uploaded to GitHub so that you (and your team) can access it from anywhere. + +
+ +## What is "Push" in Git? + +The **push** command in Git uploads your local commits to a remote repository. Think of it as “publishing” your changes to GitHub. + +```bash +git push +``` + +When you run this command, Git sends your local branch’s commits to the corresponding branch in your remote repository (for example, `main` or `master`). + +## Step-by-Step: How to Push Changes to GitHub + +### 1. Check your current branch + +Before pushing, make sure you’re on the correct branch. + +```bash +git branch +``` + +If you’re on a feature branch (e.g., `feature/update-readme`), Git will push that branch to the remote repository. + +### 2. Link your local repository to a remote (if not already) + +If your local repo isn’t connected to GitHub yet, add the remote URL: + +```bash +git remote add origin https://github.com/
+ +### 3. Push your changes + +Now that your repository is ready, push your commits using: + +```bash +git push origin main +``` + +or, if you’re working on a branch: + +```bash +git push origin your-branch-name +``` + +**Example:** + +```bash +git push origin feature/add-login-form +``` + +This command uploads all your local commits from the branch `feature/add-login-form` to GitHub. + +--- + +### 4. Enter your GitHub credentials (if prompted) + +If it’s your first time pushing, Git may ask for your GitHub username and a **Personal Access Token (PAT)** instead of your password. + +You can create one by visiting: 👉 [GitHub Personal Access Tokens](https://github.com/settings/tokens) + +### 5. Verify your changes on GitHub + +After a successful push, go to your repository on GitHub — you’ll see your commits reflected there + +You can also check the commit history: + +```bash +git log +``` + +
+ +## Common Errors and Fixes + +| Issue | Cause | Fix | +|-------|--------|-----| +| `error: failed to push some refs` | Your local branch is behind the remote branch | Run `git pull origin main --rebase` before pushing again | +| `authentication failed` | Invalid credentials or expired token | Generate a new PAT and reauthenticate | +| `remote: Repository not found` | Wrong remote URL | Double-check the repo name and your GitHub username | + +:::tip + +If you want Git to remember your remote branch for next time, you can use the `-u` flag: + +```bash +git push -u origin main +``` + +Now, you can simply run: + +```bash +git push +``` + +from then on — Git will automatically know where to push your changes. + +::: + +## Summary + +You’ve learned how to: + +- Understand what “push” means in Git +- Connect a local repository to a remote one +- Push your commits to GitHub +- Handle common push errors + +--- + +Need help? Ask your questions in the [GitHub Discussions](https://github.com/orgs/codeharborhub/discussions/categories/introduction-to-github). We’re here to help you grow as a contributor \ No newline at end of file diff --git a/docs/index.mdx b/docs/index.mdx index d259dfa..6d2bdb2 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -2,7 +2,6 @@ title: Welcome to CodeHarborHub sidebar_position: 1 slug: / -hide_table_of_contents: true --- Hello, and welcome to CodeHarborHub! Our mission is to provide accessible and comprehensive educational resources to learners of all levels, from beginners to advanced professionals. Whether you're looking to kickstart your career in web development, master a new programming language, or stay updated on the latest tech trends, we've got you covered. diff --git a/docs/react/_category_.json b/docs/react/_category_.json index 6f7bf74..0bb10f5 100644 --- a/docs/react/_category_.json +++ b/docs/react/_category_.json @@ -1,6 +1,6 @@ { "label": "React", - "position": 22, + "position": 7, "link": { "type": "generated-index", "description": "React is a JavaScript library for building user interfaces. It is maintained by Facebook and a community of individual developers and companies." diff --git a/docusaurus.config.js b/docusaurus.config.js index 3bdfdf7..1135ec2 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -135,7 +135,7 @@ const config = { { type: "html", value: `
- Tutorial
+
@@ -150,6 +150,11 @@ const config = {
},
],
},
+ {
+ to: "https://codeharborhub.github.io/blog",
+ label: "Blog",
+ position: "right"
+ },
{
href: "https://github.com/codeharborhub",
position: "right",
@@ -150,6 +150,11 @@ const config = {
},
],
},
+ {
+ to: "https://codeharborhub.github.io/blog",
+ label: "Blog",
+ position: "right"
+ },
{
href: "https://github.com/codeharborhub",
position: "right",