Setup For Editing

Setup

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

Once in the Repository click fork top right of the repository

And make a contribution copy of the Repository within your own github account.

Once on the Repository, locate a section referenced as <Code>

On the section when clicked it opens up a new panel with the information on downloading the material in a set of designated ways such as:

1. Github Desktop (An Application used for Version control)
2. Visual Studio (An IDE - Integrated Development Environment, which opens the entire code base for you to investigate).
3. Download Zip (Compresses the material available on the repository and downloads and places it to your designated location).
4. Through CMD - Command Prompt, you have an option to use the specified links given.

Github Desktop

Downloading through github Desktop you will first need to download the following:

1. Github Desktop Application Download.
2. Git Version Control Download.

Using Github Desktop:

1. When both of them are downloaded, please restart the computer for git version control to take an effect.
2. Returning, you are required to sing in within github desktop.
3. Once signed in, go back to the forked repository and select code -> open with github desktop on which you are prompted with the repository with a name you forked and a location on where you wish to place it.
4. When the repository is placed you can begin the development and bring new changes to the forked repository which can be committed through github desktop.

Please Note:

1. Upon making changes you can locate to the browser version of the forked repository, which shows either to sync the repository or open a pull request.
2. It is mandatory to first sync up the fork before opening a pull request to the main repository, otherwise the request will be denied.

Cmd

To download through CMD it is required that you download version control called git, which is available Here

1. Once git is downloaded, open CMD on your desktop search bar.
2. use cd - change directory to locate a location you wish to place the repository you wish to clone (Download)
3. As an example C:\Users\Name\cd C:\Users\Name\Desktop\NewFolder, (Defined the location of the Repository and where it is downloaded)
4. In the selected location use git clone https://github.com/VerzatileDevOrg/Programming_HandBook.git or the specified URL from your forked repository after git clone.
5. The Setup should now proceed and you can go to the location selected to open the files.

To contribute reference it in the main repository Main repository as an Issue selecting feature request or if you have spotted a mistake anywhere in the code feel free to report it from the list of templates given.

Once the reference has been posted return back to the forked repository available on your github repositories commit the followed up changes and add a pull-request, which will be looked by one of our maintainers upon which you are requested to make further changes, it is pushed or the following will be rejected.

Editing by an IDE

The following project utilizes " Visual Studio Code " to edit and modify the features of the website.

To get started with the following:

1. Download Visual Studio Code

2. Open VSC and on top right choose file -> Open folder -> and locate the repository you downloaded and open it.

3. Now you should see the project in full with all the available files, though you are now required to download extension to maximize and make changes to the project by seeing the changes.

4. You Require:

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

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

   • Live Preview
   • Live Server

5. Once these have been enabled you can begin your journey to contribute to the Open Source.

Thank you for taking the time to contribute and take an interest in the Open Source Project!