Copyright Header Guidelines

This document defines the copyright and license header format required for source files in the hve-core repository. Following these guidelines ensures compliance with OpenSSF Best Practices Gold badge criteria for copyright_per_file and license_per_file.

Overview

All source files in this repository must include a copyright and license header. We use the SPDX License Identifier standard to provide machine-readable license information.

Header Format

PowerShell Files

# Copyright (c) Microsoft Corporation.
# SPDX-License-Identifier: MIT

Applies to: .ps1 files

Placement Rules

The header placement depends on any required directives in the file:

With #Requires Statements

Place the header after any #Requires statements:

#Requires -Version 7.0
#Requires -Modules @{ ModuleName="Pester"; ModuleVersion="5.0" }
# Copyright (c) Microsoft Corporation.
# SPDX-License-Identifier: MIT

# Script content starts here

Without #Requires Statements

If no #Requires statements exist, place the header at the first line:

# Copyright (c) Microsoft Corporation.
# SPDX-License-Identifier: MIT

param(
    [string]$Path
)

References

• Microsoft Open Source - Microsoft's open source program and governance
• SPDX License List - Standard license identifiers
• SPDX License Identifier Specification - How to use SPDX identifiers in source files
• OpenSSF Best Practices Badge Criteria - Gold level requirements
• PowerShell/PowerShell header example - Reference implementation

---

🤖 Crafted with precision by ✨Copilot following brilliant human instruction, then carefully refined by our team of discerning human reviewers.