Skip to content

docs(v1.100.3a): H-10 — fix broken HEADER_SPEC.md link#505

Merged
itcmsgr merged 1 commit intomainfrom
chore/v1.100.3a-h10-header-spec-link
Apr 27, 2026
Merged

docs(v1.100.3a): H-10 — fix broken HEADER_SPEC.md link#505
itcmsgr merged 1 commit intomainfrom
chore/v1.100.3a-h10-header-spec-link

Conversation

@itcmsgr
Copy link
Copy Markdown
Owner

@itcmsgr itcmsgr commented Apr 27, 2026

Summary

Repo hygiene Phase A — slice 1a. Smallest possible doc-only fix.

Closes audit finding H-10: `CONTRIBUTING.md:242` linked to `HEADER_SPEC.md` which does not exist at repo root. `tools/validate-headers.sh` also referenced the missing file in its error message.

Why this is the smallest possible slice

The header-spec content already lives inline in `CONTRIBUTING.md` (section "File Headers" — SPDX-License-Identifier, all `meta:` tags with quoted values, all mandatory inventory keys). The broken link was a "see also" pointer to a phantom file. No new spec authoring is needed — just remove the broken pointer and clarify that the inline section is itself the authoritative spec.

Changes

  • `CONTRIBUTING.md` — section heading retitled from "HEADER_SPEC.md (File Headers)" to plain "File Headers"; broken self-link replaced by a sentence noting the inline section is authoritative and CI enforces it via `tools/validate-headers.sh`.
  • `tools/validate-headers.sh` — error message and header comment updated; no more dangling `HEADER_SPEC.md` references.

3 files changed, 23 insertions(+), 5 deletions(-) — most of the diff is the CHANGELOG entry.

Out of scope (deferred to slice 1b)

  • H-01 / H-02 / H-03 — dev-path cleanup. Separate micro-PR.

Lifecycle completion lane (PR-25..PR-30) remains explicitly OPEN.

Test plan

  • CI `Build & Test` PASS
  • CI `Build Docker Image` PASS
  • CI `Build RPM` × 2 PASS
  • CI `Build DEB` × 4 PASS
  • CI `Test DEB install` × 4 PASS
  • CI `Test RPM install` × 4 PASS
  • CI `Docs Quality` PASS
  • CI `ShellCheck` (×2) + Shell Quality PASS
  • CI `Policy Gates` PASS

🤖 Generated with Claude Code

Closes repo hygiene audit finding H-10: CONTRIBUTING.md:242 linked
to [HEADER_SPEC.md] which does not exist at repo root. The header
spec content already lives inline in CONTRIBUTING.md (section "File
Headers" — SPDX line, meta:* tags, mandatory inventory keys).

Changes:
- CONTRIBUTING.md: drop broken self-link; add a sentence noting the
  inline section IS the authoritative spec and that CI enforces it
  via tools/validate-headers.sh. Section heading retitled from
  "HEADER_SPEC.md (File Headers)" to plain "File Headers".
- tools/validate-headers.sh: error message no longer references the
  non-existent HEADER_SPEC.md. Pointer text now says
  "CONTRIBUTING.md, section 'File Headers' (authoritative spec)".
  Header comment updated to match.

Smallest zero-risk slice. No behavior change. Reviewer surface = 5
lines of doc + comment-only edits.

Out of scope (deferred to slice 1b):
- H-01 / H-02 / H-03 — dev-path cleanup, separate micro-PR.

Lifecycle completion lane (PR-25..PR-30) remains explicitly OPEN.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@itcmsgr itcmsgr merged commit e168a60 into main Apr 27, 2026
45 checks passed
@itcmsgr itcmsgr deleted the chore/v1.100.3a-h10-header-spec-link branch April 27, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant