Skip to content

Setup For Editing

VerzatileDev edited this page May 21, 2024 · 3 revisions

Fork the Repositroy


To get the latest version of the documentation site, take a look at the following link: Latest Version.


  1. Go to the repository and click the fork button at the top right of the page.

    image

  2. This will create a copy of the repository in your own GitHub account.


Clone the Repository


  1. Navigate to the forked repository on your GitHub account.

  2. Locate the Code button.

    image

  3. Click the Code button to open a panel with various download options:

    • GitHub Desktop: An application for version control.
    • Visual Studio Code: An IDE that allows you to explore the entire codebase.
    • Download ZIP: Compresses the repository files into a ZIP file for download.
    • Command Line (CMD): Use Git to clone the repository.

    image


Github Desktop


  1. Download and install the following:

  2. Restart your computer to apply the Git installation.

  3. Open GitHub Desktop and sign in with your GitHub account.

  4. Go to your forked repository, click Code, and select Open with GitHub Desktop.

  5. Choose the repository name and the location where you want to clone it.

  6. After cloning, you can begin development and commit changes through GitHub Desktop.


Note:

  • After making changes, visit the browser version of your forked repository to sync it.
  • Sync the repository before creating a pull request to the main repository. Unsynced pull requests will be denied.

Using Command Line (CMD)


  1. Download and install Git

  2. Open CMD from your desktop search bar.

  3. Use the cd (change directory) command to navigate to your desired download location.

    • For example: C:\Users\Name\cd C:\Users\Name\Desktop\NewFolder, (Defined the location of the Repository and where it is downloaded)
  4. Clone the repository using the following command:

    or

    • git clone [your-forked-repository-url]

Contributing to the Main Repository


  1. Reference your contribution in the Main repository as an Issue selecting feature request or reporting any mistakes from the list of templates given.
  2. Go back to your forked repository, commit the changes, and create a pull request. Maintainers will review your pull request and may request further changes or approve it.

Editing by an IDE (Visual Studio Code)


  1. Download and install Visual Studio Code

  2. Open Visual Studio Code, select File -> Open Folder, and locate the downloaded repository.

  3. To enhance your development experience, install the following extensions:

    • HTML & Css Support
    • Python
    • .NET Install Tool

    Optional (To see the edited file with a preview):

    • Live Preview
    • Live Server
  4. After setting up, you can begin contributing to the project.



Thank you for contributing to the Open Source Project! Your efforts are greatly appreciated.