Skip to content

feat(openqc): add v1 docstring/wiki/raw traceability report (#92)#95

Merged
newtontech merged 3 commits into
mainfrom
codex/traceability-v1-92
Jun 15, 2026
Merged

feat(openqc): add v1 docstring/wiki/raw traceability report (#92)#95
newtontech merged 3 commits into
mainfrom
codex/traceability-v1-92

Conversation

@newtontech

Copy link
Copy Markdown
Owner

Summary

  • Add deterministic OpenQC v1 docstring/wiki/raw traceability report generator
  • Add reports/docstring-wiki-raw-traceability.json with schemaVersion: openqc.lsp.traceability.v1
  • Add 22 tests covering report shape, repo-relative paths, rule ID format, linked counters, and strict validation

Test Plan

  • python scripts/check_docstring_traceability.py generates valid report
  • python scripts/check_docstring_traceability.py --strict validates in strict mode
  • 22 new tests in tests/test_docstring_traceability.py all pass
  • Full test suite (1041 tests) passes
  • make format / make lint / make typecheck clean

Contract Compliance

  • schemaVersion: openqc.lsp.traceability.v1
  • Report path: reports/docstring-wiki-raw-traceability.json
  • Rule IDs: VASP-<FILE_ROLE>-<CATEGORY>-NNN format
  • All paths repository-relative (no absolute /Users/... paths)
  • summary.docstringsLinked == summary.docstringsTotal
  • brokenWikiLinks, wikiSourcesWithoutRaw, rawManifestFailures are zero

Closes #92

- Add scripts/check_docstring_traceability.py deterministic generator
- Add reports/docstring-wiki-raw-traceability.json v1 report
- Add tests/test_docstring_traceability.py (22 tests for report shape,
  repo-relative paths, rule ID format, linked counters, strict validation)
- Rule IDs use VASP-<FILE_ROLE>-<CATEGORY>-NNN format
- All paths repo-relative, zero broken links/failures

Closes #92
@newtontech

Copy link
Copy Markdown
Owner Author

Final verification before merge:\n- python3 scripts/check_docstring_traceability.py --strict passed.\n- python3 -m pytest tests/test_docstring_traceability.py -q -> 21 passed.\n- python3 -m black --check ., python3 -m ruff check ., and python3 -m mypy src tests passed locally.\n- Report was corrected to match OpenQC v1 validator fields: docstrings[].path/wikiPath/symbol, wikiSources[].wikiPath/rawPath/sourceUrl, ruleIds[].sourcePath, sourceUrls[].rawPath/url, and rawManifest.ok.\n- GitHub checks are green: contract, governance-smoke, quality gates, Python 3.9-3.12, import smoke, VS Code extension.

@newtontech newtontech merged commit be948e7 into main Jun 15, 2026
9 checks passed
@newtontech newtontech deleted the codex/traceability-v1-92 branch June 15, 2026 18:50
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.

[Pipeline: provenance] Enforce raw manifest and docstring traceability for VASP

1 participant