From 734c3c56df646b2280381b75f908bac20925671d Mon Sep 17 00:00:00 2001 From: Brylie Christopher Oxley Date: Mon, 5 Sep 2016 10:49:10 +0300 Subject: [PATCH 1/4] Fix indentation --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7aad15116..6a45d157ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -320,8 +320,8 @@ In general, our file structure follows this pattern: * *schema.js* * *permissions.js* * *helpers.js* - * **server/** - * *publications.js* + * **server/** + * *publications.js* * **client/** * **lib/** * *router.js* From cd0998602eb51a202252540ddacb84d6889f5b0d Mon Sep 17 00:00:00 2001 From: Brylie Christopher Oxley Date: Mon, 5 Sep 2016 10:51:11 +0300 Subject: [PATCH 2/4] Alphebetize directories --- CONTRIBUTING.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a45d157ec..2afe4a267d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -314,14 +314,6 @@ By 'module', we mean anything that has it's own database collection and one or m In general, our file structure follows this pattern: * **/ (project root)** - * **module_name/** - * **collection/** - * *index.js* - * *schema.js* - * *permissions.js* - * *helpers.js* - * **server/** - * *publications.js* * **client/** * **lib/** * *router.js* @@ -333,6 +325,13 @@ In general, our file structure follows this pattern: * *sub_component.css* * *sub_component.html* * *sub_component.js* + * **collection/** + * *index.js* + * *schema.js* + * *permissions.js* + * *helpers.js* + * **server/** + * *publications.js* * **server/** * *methods.js* From a3dbf4a6a6671f82fbafbf4a3532bff4d5a57dde Mon Sep 17 00:00:00 2001 From: Brylie Christopher Oxley Date: Mon, 5 Sep 2016 10:57:42 +0300 Subject: [PATCH 3/4] De-indent --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2afe4a267d..891e392a51 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -309,31 +309,31 @@ Reference: Meteor Guide - Check Your Code with ESLint [Integrating with your ed # File structure This project is organized around a 'module' / 'component' architecture. -By 'module', we mean anything that has it's own database collection and one or more routes. Components are more closely related to the idea of [WebComponents](http://webcomponents.org/), which are intended to be reusable, hierarchical user interface elements. - -In general, our file structure follows this pattern: - -* **/ (project root)** - * **client/** - * **lib/** - * *router.js* - * **component_one/** - * *component_one.css* - * *component_one.html* - * *component_one.js* - * **sub_component/** - * *sub_component.css* - * *sub_component.html* - * *sub_component.js* - * **collection/** - * *index.js* - * *schema.js* - * *permissions.js* - * *helpers.js* - * **server/** - * *publications.js* +By 'module', we mean anything that has it's own database collection and one or more routes. Components are more closely related to the idea of [WebComponents](http://webcomponents.org/), which are intended to be reusable, hierarchical user interface elements. Modules are located in the project root, with components in the client sub-directory. + +In general, our module structure follows this pattern: + +* **/module_name** + * **client/** + * **lib/** + * *router.js* + * * **component_one/** + * *component_one.css* + * *component_one.html* + * *component_one.js* + * **sub_component/** + * *sub_component.css* + * *sub_component.html* + * *sub_component.js* + * **collection/** + * *index.js* + * *schema.js* + * *permissions.js* + * *helpers.js* * **server/** - * *methods.js* + * *publications.js* + * **server/** + * *methods.js* ## File names Please use underscores in folder and file names, rather than hyphens or camel case. E.g. From 66ddd2e15013d4567096e97a5381933e254caf91 Mon Sep 17 00:00:00 2001 From: Brylie Christopher Oxley Date: Mon, 5 Sep 2016 10:59:30 +0300 Subject: [PATCH 4/4] Indentation and typo --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 891e392a51..67e83cee01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -315,9 +315,7 @@ In general, our module structure follows this pattern: * **/module_name** * **client/** - * **lib/** - * *router.js* - * * **component_one/** + * **component_one/** * *component_one.css* * *component_one.html* * *component_one.js* @@ -325,6 +323,8 @@ In general, our module structure follows this pattern: * *sub_component.css* * *sub_component.html* * *sub_component.js* + * **lib/** + * *router.js* * **collection/** * *index.js* * *schema.js*