Directories structure guidelines should be added
minhnguyencrypted opened this issue · comments
Minh Nguyen commented
Guidelines for directories structure is necessary for source codes organisation.
These guidelines will regulate the ways people's works are placed and organised for tracking and improving.
Proposed structure:
/
orroot
directory: this is the first place everyone see in the repository, this should be the place for general-purpose
files likeREADME.md
,CONTRIBUTING.md
, or other configuration and guidelines files/source
or/src
: this is where source files (*.html
,*.css
,*.js
, etc.) are placed, these files can be built into executables. There maybe directories of other files used by the program or media files for the HTML pages also put inside here, such as:media
: for media files: images, videos, audio, etc.header
: for programming headersdata
: for storing data
/pages
: equivalent tosource
, should be either of 'em exists./Documentation
: for documentations such as flowcharts, changelogs, etc.- Designated directories produced by IDEs/Editors: if it's totally dependent on using these tools, these kinds of directories should be pushed to the repository, ideally place 'em in
root
directory.