Contributing to Learn-git-with-me

Thank you for your interest in contributing to GitME! Your support is greatly appreciated, and we look forward to your valuable contributions.

Getting Started

Fork this repository
Click here to create a fork of the repository.
Clone your forked repository to your local machine
Use the following command to clone your forked repository:
```
git clone https://github.com/<YOUR_USERNAME>/Learn-git-with-me.git
```
Navigate to the project directory
Change into the project directory with:
```
cd Learn-git-with-me
```
Create a new branch
Create a new branch for your changes:
```
git checkout -b my-new-branch
```
Install dependencies
Install the necessary dependencies by running:
```
npm install
```

Create a .env.local file
Set up your environment variables by creating a .env.local file:

touch .env.local && echo "NEXT_PUBLIC_APP_URL=http://localhost:3000" > .env.local

To edit documentation or commands, please follow these steps:

Locate the Documentation or Command
Navigate to contents/docs/essential-commands and open the index.mdx file.
For instance, you may need to edit "contents/docs/essential-commands/branching/git-checkout/index.mdx".
Review the documentation to identify what needs updating.
Make Your Changes
Open the relevant Markdown file or command script and implement your edits.
Utilize Markdown Syntax
Ensure that you apply the correct Markdown syntax for headings, lists, and code blocks.
Test Your Changes
If you modify any commands, test them locally to confirm they function as expected.
Commit Your Changes
Use a clear and descriptive message for your commit.
Push Your Changes
Push your changes to your branch on GitHub.
Create a Pull Request
After pushing, create a pull request for review and provide an explanation of your changes.

By adhering to these steps, you can make significant contributions to enhancing the documentation and command structure of the project.

To contribute new documentation or commands, please follow these steps:

Navigate to the content/docs directory
Create a new folder named after the documentation or command you wish to add.
Create an index.mdx file in that folder
Write the relevant documentation in this file, ensuring it is clear and comprehensive.
Update the left sidebar navigation
To display your new documentation in the left sidebar, open the lib/routes-config.ts file, which manages page navigation and sorting in the sidebar.

Add an entry similar to the following structure:
```
{
  title: "Basic Concepts",
  href: "/basic-concepts",
  noLink: true,
  items: [
    { title: "Why Use Git", href: "/why-use-git" },
    {
      title: "Tips to Master Git",
      href: "/tips",
    },
  ],
},
```
Ensure that your new entry is placed appropriately within the existing structure to maintain organization and accessibility.
Test Your Changes
If you modify any commands, test them locally to confirm they function as expected.
Commit Your Changes
Use a clear and descriptive message for your commit.
Push Your Changes
Push your changes to your branch on GitHub.
Create a Pull Request
After pushing, create a pull request for review and provide an explanation of your changes.

If you have any questions or need assistance, please open a new GitHub issue. We are here to help you!