Core Docs

Coding Conventions

Coding Conventions



Standards and conventions used across all UNVRSL repositories.

PHP



  • PHP version: >= 8.1

  • Autoloading: PSR-4

  • Namespace root: UNVRSL\Core\ (for core services)

  • Coding style: PSR-12

JavaScript



  • No frameworks — vanilla JS by default

  • No build tools — plain JS files served via core.assets

  • Module pattern: IIFE or ES modules where supported

HTML/CSS



  • HTML5 — semantic elements preferred

  • CSS — no preprocessors by default

  • Responsive — mobile-first approach

Repository Structure



repo-name/
├── src/ # Source code
├── public/ # Web-accessible entry points
├── bootstrap/ # Initialization scripts
├── composer.json # PHP dependencies
├── README.md # Repository readme
└── .gitignore


Naming



  • Files: kebab-case (datetime-parsers.php)

  • Classes: PascalCase (DocumentShell)

  • Functions: camelCase (parseDateTime)

  • Constants: UPPER_SNAKE_CASE

Git



  • Branch: main as default

  • Commits: descriptive messages, present tense

  • No tags yet — use dev-main for Composer dependencies