Skip to content

docs: add copyright header guidelines for contributors #303

@WilliamBerryiii

Description

@WilliamBerryiii

Description

Create contributor documentation explaining the copyright and license header format required for source files in this repository. This documentation enables consistent header application across all file types and serves as the authoritative reference for other implementation tasks.

The hve-core repository requires headers to meet OpenSSF Gold badge criteria for copyright_per_file and license_per_file.

Acceptance Criteria

  • Create docs/contributing/copyright-headers.md
  • Include header format examples for PowerShell, Bash, Python, and C#
  • Document placement rules (after shebang, after #Requires statements)
  • Reference the MIT license and SPDX standard
  • Add link to this document from CONTRIBUTING.md
  • Frontmatter validates against schema

Implementation Steps

  1. Create docs/contributing/copyright-headers.md with the following sections:

    • Overview explaining the OpenSSF requirement
    • Header format table by file type
    • Placement rules and examples
    • Links to SPDX documentation
  2. Use this header format for all file types:

    # Copyright (c) Microsoft Corporation.
    # SPDX-License-Identifier: MIT
    
  3. Include language-specific variations:

    PowerShell/Bash/Python:

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

    C#/TypeScript:

    // Copyright (c) Microsoft Corporation.
    // SPDX-License-Identifier: MIT
  4. Document placement rules:

    • Shell scripts: After the shebang line (#!/bin/bash)
    • PowerShell: After any #Requires statements
    • Other files: First lines of the file
  5. Add a reference link in CONTRIBUTING.md under the appropriate section

References

Time Estimate

1-2 hours

Dependencies

None (this issue should be completed first)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions