Code Organized with proper indentation and comments

[Xaid-vfx]

Fixes

Fixes #101 by @Xaid-vfx

• [Feature] Organise code with proper indentation and comments #101

Description

The code structure has been arranged in compliance with standard formatting conventions and indentation. Furthermore, comments have been added to specific areas within the code to assist future developers in locating and contributing to it with ease.

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the default branch of the repository (main or master).
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no
  visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[justaskulkarni]

Hey @Xaid-vfx, there is still a bit more work needed before this PR can be merged.
The code structure in docs/submission.html also needs to be organized with proper indentation and comments.

[Xaid-vfx]

Hey @Xaid-vfx, there is still a bit more work needed before this PR can be merged. The code structure in docs/submission.html also needs to be organized with proper indentation and comments.

Done !!

[justaskulkarni]

Looks good to me. Nice work 😊

[possumbilities]

@Xaid-vfx Usually the head area isn't indented, and a few files might be missing "End of line" characters.

Also need to resolve the merge conflicts, but other than that once the above is run through again this would likely be approvable. Well done!

[Xaid-vfx]

@Xaid-vfx Usually the head area isn't indented, and a few files might be missing "End of line" characters.

Also need to resolve the merge conflicts, but other than that once the above is run through again this would likely be approvable. Well done!

Hey @possumbilities,
I might sound dumb but could you give an example of few files might be missing "End of line" characters. I couldn't quite grasp what you meant there exactly.

[Lakshay-Pruthi]

@Xaid-vfx you may have used an extension for this but the extension hasn't worked properly.

The stylesheet link and heading tag should be in a single line and the extension has also added a line after curly brace { at some places which is not required so I would suggest you to use any other extension such as Prettier - Code formatter and it would be great if you check for inappropriate indentation after that and manually fix them.

[possumbilities]

@Xaid-vfx Usually the head area isn't indented, and a few files might be missing "End of line" characters.
Also need to resolve the merge conflicts, but other than that once the above is run through again this would likely be approvable. Well done!

Hey @possumbilities, I might sound dumb but could you give an example of few files might be missing "End of line" characters. I couldn't quite grasp what you meant there exactly.

@Xaid-vfx

If you view the files tab on this PR you can see a little red circle with a line through it at the end of some of the files:

This means it's missing an end of file character, which you can have your editor automatically add when editing/saving files.

[Xaid-vfx]

@possumbilities Thank you so much. I'll update this PR asap.

[Xaid-vfx]

@possumbilities Since this PR was raised long time back, its branch is 43 commits behind and has a few conflicts. Should I raise a new PR with a new branch (this way all the new code would be organized as well) or just push the changes without merging 43 commits?

[possumbilities]

@Xaid-vfx You should be able to work through resolving the merge conflicts and keep this PR. But you can also close this PR and start a fresh one since its so far behind.

I'd suggest trying to resolve the conflicts, first though. It should be possible.

[possumbilities]

@Xaid-vfx do you intend to resolve the conflicts and move this out of Draft?

[TimidRobot]

Please create a new PR based on the prettify branch (or the main branch, if it's already merged) with the comments you've added (don't forget to format using prettier before pushing your changes).