From 3fbfe5627c16ec4fe747df61d013ea0bc10fd4a2 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 16 Feb 2023 08:10:33 -0800 Subject: [PATCH] Add example of subject folder listing (#34804) --- src/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/README.md b/src/README.md index f13c7bd4b2..f8a4279196 100644 --- a/src/README.md +++ b/src/README.md @@ -10,6 +10,21 @@ We used to organize our code more by role: client, stylesheets, server middlewar Run `script/create-subject.js --name x` to create a new subject folder. +Subjects do not need every element below. Not every element needs to be a folder. A subject folder looks similar to: + +``` +src/ + xsubject/ + README.md + components/ + lib/ + tests/ + scripts/ + stylesheets/ + pages/ + docs/ +``` + We compose subjects together like TBD - still a work in progress! How to declare a subject depends on another subject TBD - still a work in progress!