Skip to content

Commit 8ceb2bd

Browse files
committed
PR_26172_OWNER_034-canonical-repository-structure
1 parent 0623d9c commit 8ceb2bd

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

docs_build/dev/ProjectInstructions/README.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,6 @@ READ THIS FIRST
4040
9. Follow OWNER governance decisions.
4141
10. When guidance conflicts, newest OWNER-approved guidance wins.
4242
11. Batch Governance Mode is the default for governance, documentation, and administrative work.
43+
44+
Addendum index:
45+
- Canonical Repository Structure: project-instructions/addendums/canonical-repository-structure.md
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Canonical Repository Structure
2+
3+
## Purpose
4+
5+
Establish the canonical repository structure for future development and reduce technical debt.
6+
7+
## Canonical Structure
8+
9+
Tools:
10+
- toolbox/{tool-name}/index.html
11+
12+
Tool assets:
13+
- assets/toolbox/{tool-name}/js/index.js
14+
- assets/toolbox/{tool-name}/css/index.css
15+
16+
Themes:
17+
- assets/theme-v1/
18+
- assets/theme-v2/
19+
20+
Shared JavaScript:
21+
- assets/js/shared/
22+
23+
Engine:
24+
- src/engine/{feature-name}/
25+
26+
API:
27+
- api/{feature-name}/
28+
29+
Serverside:
30+
- serverside/{feature-name}/
31+
32+
## Rules
33+
34+
- Theme first.
35+
- Tool CSS second.
36+
- Shared functionality belongs in assets/js/shared/.
37+
- No new scattered JS folders.
38+
- No new scattered CSS folders.
39+
- New development follows the canonical structure.

0 commit comments

Comments
 (0)