Skip to content

Commit 427ccba

Browse files
committed
[MODIFY] CONTRIBUTING.md, [ADD] FOLDER-STRUCTURE.md
1 parent c787b4e commit 427ccba

2 files changed

Lines changed: 64 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ compiler-installation-guidelines.md is correct
132132
## New Directory guidelines
133133

134134
- Folder name should be in full lowercase. If the name has multiple words, separate them by dashes(-). (e.g. : `getting-started`)
135-
- We recommend adding files to existing directories as much as possible.
135+
- We recommend adding files to existing directories as much as possible (Take a look at **[folder structure](FOLDER-STRUCTURE.md)**).
136136
- New folder should contain `README.md` with proper description of the folder.
137137
- Use lowercase words with ```"-"``` as separator (spaces or ```"_"``` not allowed)
138138
- For instance

FOLDER-STRUCTURE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Folder structure being followed
2+
3+
All the core and common _stylesheets **(.css)**, fonts **(.ttf, .otf)**, image **(.jpg, .png, ..)**, javascript **(.js)**_ and _sass **(.scss)**_ files are placed inside the [assets folder](https://github.com/devCANS/website/tree/master/assets).
4+
Sub-folders can be created inside these directories for better management.
5+
<pre>
6+
ROOT
7+
|- assets
8+
|- css/
9+
|- fonts/
10+
|- img/
11+
|- js/
12+
|- vendor <i>[optional folder to store 3<sup>rd</sup> party css, js or plugins]</i>
13+
|- css
14+
|- js
15+
|- sass/
16+
</pre>
17+
18+
All files containing necessary (minimum required for this repository to run on a local server) table structures ***(.sql, ..)*** are placed inside [sql folder](https://github.com/devCANS/website/tree/master/sql/).
19+
<pre>
20+
ROOT
21+
|- sql/
22+
</pre>
23+
24+
All files performing _database operations_ or _server-side operations_ are placed inside [server folder](https://github.com/devCANS/website/tree/master/server/). Sub-folders can be created inside this directory for better management.
25+
<pre>
26+
ROOT
27+
|- server/
28+
</pre>
29+
<br>
30+
31+
A new web page can be made at **ROOT** level or a group of similar webpages **inside a separate folder** at **ROOT** level.
32+
<pre>
33+
Example:
34+
ROOT
35+
|- index.html <i>(single web page at ROOT level)</i>
36+
37+
<b>OR</b>
38+
39+
ROOT
40+
|- dashboard <i>(group of similar webpages inside a separate directory)</i>
41+
|- index.html
42+
|- similar-webpage.html
43+
|- another-page.html
44+
45+
<b>TIP:</b> <i>When using a separate folder, additional css and js folders may be created inside this directory
46+
specially for the web pages inside the directory</i>
47+
Example:
48+
ROOT
49+
|- dashboard
50+
|- css/
51+
|- js/
52+
|- index.html
53+
|- similar-webpage.html
54+
</pre>
55+
<br>
56+
57+
Files that are common to other files (or which are needed to be included in other pages) are stored inside [includes folder](https://github.com/devCANS/website/tree/master/includes).
58+
<pre>
59+
ROOT
60+
|- includes/
61+
|- dashboard
62+
|- includes/ <i>(can also be made inside a directory exclusively for the files inside the directory)</i>
63+
</pre>

0 commit comments

Comments
 (0)