4
File-Header-Standards
Jonathan Miller edited this page 2026-06-09 16:55:04 +00:00

File Header Standards

SPDX license header format for all source files.

PHP Header

<?php

/* Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
 *
 * This file is part of a Moko Consulting project.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * FILE INFORMATION
 * DEFGROUP: MokoPlatform.Lib
 * INGROUP: MokoPlatform
 * REPO: https://git.mokoconsulting.tech/MokoConsulting/mokoplatform
 * PATH: /lib/CliBase.php
 * BRIEF: Standalone base CLI class
 */

declare(strict_types=1);

Fields

Field Purpose
SPDX-License-Identifier License (GPL-3.0-or-later, MIT)
DEFGROUP Module/component group
INGROUP Parent group
REPO Full repository URL
PATH File path within repo
BRIEF One-line description

YAML/Bash Header

# Copyright (C) 2026 Moko Consulting
# SPDX-License-Identifier: GPL-3.0-or-later

Enforcement

validate/check_license_headers.php checks all source files for headers.

php validate/check_license_headers.php --path /path/to/repo