hpe-copyright

majiayu000 的头像作者 majiayu000

检查、添加或修复源文件中的 HPE 版权标头。在以下情况下使用此技能:(1) 将版权标头添加到新文件,(2) 检查文件是否具有有效的版权标头,(3)​​ 更新过时的版权年份,(4) 为强制执行版权标头的 CI 准备代码,(5) 用户提及“版权”、“HPE 标头”或“版权检查”。格式为“Copyright YYYY-YYYY Hewlett Packard Enterprise Development LP”作为第一行的注释。

📖 中文导读:检查、添加或修复源文件中的 HPE 版权标头。在以下情况下使用此技能:(1) 将版权标头添加到新文件,(2) 检查文件是否具有有效的版权标头,(3)​​ 更新过时的版权年份,(4) 为强制执行版权标头的 CI 准备代码,(5) 用户提及“版权”、“HPE 标头”或“版权检查”。格式为“Copyright YYYY-YYYY Hewlett Packard Enterprise Development LP”作为第一行的注释。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

HPE Copyright Header Management

Ensure all source files have the required HPE copyright header to pass CI checks.

Copyright {start_year}-{end_year} Hewlett Packard Enterprise Development LP
  • start_year: Year the file was created
  • end_year: Current year (must be updated annually)
  • Placement: First line of the file, as a comment

Examples by Language

Language Copyright Line
Python # Copyright 2024-2025 Hewlett Packard Enterprise Development LP
JavaScript/TypeScript // Copyright 2024-2025 Hewlett Packard Enterprise Development LP
Go // Copyright 2024-2025 Hewlett Packard Enterprise Development LP
SQL -- Copyright 2024-2025 Hewlett Packard Enterprise Development LP
HTML/XML <!-- Copyright 2024-2025 Hewlett Packard Enterprise Development LP -->
CSS /* Copyright 2024-2025 Hewlett Packard Enterprise Development LP */

Quick Reference

Check all files (dry run)

python scripts/copyright_check.py /path/to/repo --dry-run

Fix all files

python scripts/copyright_check.py /path/to/repo

CI check mode (fails if issues found)

python scripts/copyright_check.py /path/to/repo --check-only

Rules

  1. Missing header: Add Copyright CURRENT_YEAR-CURRENT_YEAR Hewlett Packard Enterprise Development LP
  2. Outdated year: Update only the second year to current year (e.g., 2024-2024 → 2024-2025)
  3. Exclusions: Respects both .gitignore and .copyrightignore files (gitignore-style patterns)

Manual Fixes

When manually adding or fixing a copyright header:

  1. Determine the correct comment syntax for the file type
  2. Add as the very first line of the file
  3. Use current year for both years if creating new: Copyright 2025-2025 Hewlett Packard Enterprise Development LP
  4. If updating existing, only change the second year

Supported File Types

The script supports 50+ file extensions including:

  • Hash (#): .py, .sh, .rb, .pl, .r, .jl
  • Double-slash (//): .js, .ts, .jsx, .tsx, .go, .c, .cpp, .java, .kt, .swift, .rs
  • Dash-dash (--): .sql, .lua, .hs
  • Block comments: .html, .xml, .css, .vue

Exclusion Patterns

The script automatically reads patterns from both .gitignore and .copyrightignore in the repo root. Use .copyrightignore for additional exclusions specific to copyright checking:

# Directories
vendor/**
third_party/**

# File types not in .gitignore
*.generated.go

# Specific files
Makefile