7.2 Directory Naming

Go To Top

Return to Naming and File Conventions

Directory names should be short, descriptive, and stable. Top-level directory names should identify major Artifact categories, such as source files, generated Artifacts, Configuration, scripts, containers, tests, documentation, logs, tools, and Evidence.

The Repository should use lowercase directory names where practical. Multi-word directory names should use hyphens or another team-approved convention consistently. The team should avoid mixing styles such as controlPlane, control-plane, control_plane, and ControlPlane for the same Artifact type.

Representative directory names include:

docs/
idl/
src/
generated/
config/
scripts/
containers/
tests/
logs/
evidence/
tools/

Subdirectories should refine the parent directory's purpose. For example:

• src/control-plane/
• src/data-plane/
• config/nodes/
• config/qos/
• scripts/setup/
• scripts/generation/
• tests/acceptance/

Developers should not create new top-level directories without a clear Baseline purpose. When the team adds a new top-level directory, it should update the Repository layout documentation and, where needed, this handbook.