Skip to content

Commit

Permalink
docs: update filenaming and organization - Closes #7
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Owsiak committed Apr 5, 2018
1 parent 481e14e commit 6593962
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ There's some important differences that are mostly around our focus on sticking
and a higher bar for rules that don't support `--fix`:
If a rule isn't clearly preventing bugs, it has to support `--fix` to be enabled.

Additionally, our file naming convention is `kabab-case`. File names should be entirely in lowercase to avoid any renaming issues with file systems.

Regarding code organization, we generally structure code by domain, not by layer (`todos/model.js` instead of `models/todo.js`).

To ensure good automation support, we're also dropping any rules that conflict with prettier's formatting.

### The Longer Answer
Expand Down

0 comments on commit 6593962

Please sign in to comment.