-
Notifications
You must be signed in to change notification settings - Fork 125
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
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
#Requiresstatements) - Reference the MIT license and SPDX standard
- Add link to this document from
CONTRIBUTING.md - Frontmatter validates against schema
Implementation Steps
-
Create
docs/contributing/copyright-headers.mdwith the following sections:- Overview explaining the OpenSSF requirement
- Header format table by file type
- Placement rules and examples
- Links to SPDX documentation
-
Use this header format for all file types:
# Copyright (c) Microsoft Corporation. # SPDX-License-Identifier: MIT -
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
-
Document placement rules:
- Shell scripts: After the shebang line (
#!/bin/bash) - PowerShell: After any
#Requiresstatements - Other files: First lines of the file
- Shell scripts: After the shebang line (
-
Add a reference link in
CONTRIBUTING.mdunder the appropriate section
References
Time Estimate
1-2 hours
Dependencies
None (this issue should be completed first)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers