Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds starting folders and readme files. #11

Closed
wants to merge 9 commits into from
10 changes: 9 additions & 1 deletion src/styles/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
Application styles
# Application styles

## Naming Conventions: BEM

TODO: Outline what BEM is and how to use/extend classes using it.

## Recommendations on Folding In Third Party CSS

TODO: Outline how/when/why to fold in third party css using npm or yarn.
3 changes: 3 additions & 0 deletions src/styles/patterns/base/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Base

TODO: Outline what qualifies as a 'base' pattern.
3 changes: 3 additions & 0 deletions src/styles/patterns/containers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Containers

TODO: Outline what qualifies as a 'container' pattern.
3 changes: 3 additions & 0 deletions src/styles/patterns/layouts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Layouts

TODO: Outline what qualifies as a 'layout' pattern.
7 changes: 7 additions & 0 deletions src/styles/patterns/pages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Pages

A pages folder will not always be needed, and restraint should be used
in leveraging it. The most likely case of it being needed will be in the
event the homepage of a site is drastically different from other pages.

TODO: Outline what qualifies as a 'page' pattern.
9 changes: 9 additions & 0 deletions src/styles/vendor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Vendor Styles

Optional folder.

In cases where third party CSS needs to be included in the source files
of a project, this is where that third party code should go.

However, it's strongly recommended to leverage npm or yarn to include
third party code that way instead.