Project Structure Checklist

Version: 2.0
Scope: Repository layout and folder/namespace conventions.

Required Folders

  • [ ] 3rd/ - Third-party libraries (audited only)
  • [ ] bin/ - Debug build output (gitignored)
  • [ ] cfg/ - Source configs (copied to bin/ on build)
  • [ ] dat/ or db/ - Databases, SQL schemas
  • [ ] doc/ - README.md + PROJECT.md + SKILL.md
  • [ ] pub/ - Release builds (gitignored)
  • [ ] src/ - Source code (CLEAN, no artifacts!)
  • [ ] uti/ - Test tools, load tests, utilities
  • [ ] lib/ - Compiled units (gitignored)
  • [ ] .gitignore correctly configured

Namespace-based Folder Structure

  • [ ] Folder paths mirror unit namespace hierarchy
  • [ ] Pattern: src/{category}/WvdS.*.{Category}.*
  • [ ] Sub-folders for subcategories: src/widgets/data/
  • [ ] Compound words separated with dots: Alarm.List, not AlarmList

Repository Categories (Multi-Project)

For workspaces with multiple projects:

WvdS.FPC/
├── lib/      # Reusable libraries (build first)
├── apps/     # End-user applications
└── tools/    # Development tools (VSIX, scripts)
  • [ ] lib/ - Reusable libraries (WvdS.Core, WvdS.Data, etc.)
  • [ ] apps/ - End-user applications (WvdS.Console.TUI, WvdS.Data.Gateway)
  • [ ] tools/ - Development tools
    • [ ] tools/vscode-extension/ - VSIX extensions
    • [ ] tools/build-scripts/ - Build automation
  • [ ] Build order: lib/ → apps/ → tools/

Version: 2.0 (Split)
Author: Wolfgang van der Stille

Back to Project Checklists | Review Checklists

Zuletzt geändert: on 2026/01/08 at 01:50 AM