search

rneha725 / Online-Judge-for-LITG

Project for Learn It, Girl 2016.
1 stars 0 forks source link

Reorganize folder structure #1

Closed dshgna closed 8 years ago

dshgna commented 8 years ago

While there are no set guidelines for a project's folder structure, separation of concerns is generally a best practice. Best Practices

In the current setup, several JS and HTML files are mixed up. This makes navigation complicated. Something around this folder structure would be much better.

root

Some finer points

  1. Index.html is a better recognized for the root file than home.html.
  2. For now, directly include the 3rd party libraries via CDN. (Codepen handles most of this). Before deploying the app, we can use Bower to handle all 3rd party library dependencies.
  3. Bootstrap should be included unzipped :)
rneha725 commented 8 years ago

I have changed the folder structure as suggested. Please refer to this commit message for folder structure: commit All points considered.

dshgna commented 8 years ago

Excellent work. This issue can be closed now.

Just a small point on commit messages. The usual naming convention is to write the heading as imperative, like you are commanding someone. For example 'Fix all changes in the Feb 17th issue". More pointers here. As this fix is basically a reorganization, a shorter commit message would be perfectly acceptable too.

rneha725 commented 8 years ago

Thanks for suggestions, I will try to utilize all this in future.