Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 23 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,32 +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)**
* **module_name/**
* **collection/**
* *index.js*
* *schema.js*
* *permissions.js*
* *helpers.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/**
* **component_one/**
* *component_one.css*
* *component_one.html*
* *component_one.js*
* **sub_component/**
* *sub_component.css*
* *sub_component.html*
* *sub_component.js*
* **lib/**
* *router.js*
* **collection/**
* *index.js*
* *schema.js*
* *permissions.js*
* *helpers.js*
* **server/**
* *publications.js*
* **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*
* **server/**
* *methods.js*
* **server/**
* *methods.js*

## File names
Please use underscores in folder and file names, rather than hyphens or camel case. E.g.
Expand Down