Eve library

Neith QA Training Materials

Guide

Revision 1

On this page

Training path for contributors extending @neith/qa.

Audience#

  • engineers adding or modifying Phase 52 certification gates
  • reviewers responsible for keeping Neith evidence deterministic
  • maintainers publishing certification markdown and report types

Learning Objectives#

  • understand the standard auditor structure used throughout src/code-quality/
  • add report and issue models without introducing schema drift
  • write fixture-backed and repo-backed Vitest coverage for each new gate
  • keep published certification markdown synchronized with generated output

Curriculum#

Module 1: Auditor Fundamentals#

Study the existing documentation and sovereignty auditors. Focus on explicit path inventories, section-marker checks, and deterministic filesystem reads.

Module 2: Evidence Publishing#

Trace how formatter helpers produce certification ledgers under docs/domains/neith/. Learn how discoverability links are enforced from the standalone Neith docs hub and Oshun-local references.

Module 3: Verification Discipline#

Practice adding negative fixture tests, repo-backed certification tests, type-safe report summaries, and API reference updates for a new gate.

Hands-On Labs#

  1. Add a fixture repo with incomplete docs and verify that the auditor reports the missing paths and section markers you expect.
  2. Generate a certification preview and compare it with the published markdown ledger in docs/domains/neith/.
  3. Extend docs/domains/neith/qa/api/README.md so the public QA surface stays aligned with the implemented auditors.

Assessment And Evidence#

Successful completion means the trainee can:

  • add a new auditor, report type, and formatter without breaking typecheck
  • explain why the fixture and repo-backed tests prove the certification claim
  • update the standalone and Oshun-local docs indexes so the new evidence is discoverable

Commands Used In Training#

bash
pnpm nx run @neith/qa:typecheck
pnpm nx run @neith/qa:lint
pnpm nx run @neith/qa:test
pnpm nx run @neith/qa:sbom