Skip to content

CHANGELOG.md

Latest commit

 

History

History
134 lines (106 loc) · 5.12 KB

CHANGELOG.md

File metadata and controls

134 lines (106 loc) · 5.12 KB
Raw

Changelog

All notable changes to project-standard are documented here.

The format follows Keep a Changelog:

  • Added — new checks, perspectives, or features
  • Changed — changes in existing checks or weights
  • Deprecated — checks that will be removed
  • Removed — removed checks or features
  • Fixed — bug fixes or clarifications
  • Security — security-related changes

[Unreleased]

Added

  • Industry Vertical perspective with 5 vertical modules:
    • Healthcare (HIPAA / HL7 FHIR)
    • Finance (PCI-DSS / SOC 2 / SOX)
    • Education (FERPA / COPPA)
    • Government (FedRAMP / FISMA / Section 508)
    • IoT / Embedded (IEC 62443 / FDA IoT)
  • IND_* check IDs for all vertical modules
  • Industry vertical evaluation criteria and output template

[1.1.0] — 2026-04-11

Added

  • Check Registry (references/check-registry/check-registry.md)

    • Centralized ID registry for all 71 checks across 19 perspectives
    • Format: {PER}_{DIM}_{NUM}
    • Deprecated check tracking with replacement references
    • Version 1.0 of the registry

  • Version Migration Strategy (references/version-migration.md)

    • Three-level versioning (major.minor.patch)
    • Deprecation process: mark → notify → sunset → remove
    • Scan history compatibility (never reindex)
    • Learning store compatibility via check_hash
    • Release process checklist

  • Arbitration Rules (Expanded) (references/arbitration-rules.md)

    • Part 1: Ownership matrix (which perspective owns what)
    • Part 2: Explicit overlap rules (5 defined overlaps)
    • Part 3: Scanner dependency graph (Level 0–4 execution)
    • Part 4: Conflict resolution flowchart
    • Part 5: Escalation process

  • Perspective Dependencies (references/perspective-dependencies.md)

    • Machine-readable dependency graph (YAML)
    • Execution levels per perspective
    • Data flow contracts between scanners
    • Conflict markers for cross-scanner findings
    • Execution configuration (parallelism, timeouts, retries)

  • CONTRIBUTING.md (references/CONTRIBUTING.md)

    • Quick start guide for contributors
    • Check ID assignment rules
    • Document format requirements
    • PR review checklist
    • Common mistakes to avoid

  • Validation Scripts (scripts/)

    • validate_check_ids.py — detect duplicate IDs, format validation
    • validate_links.py — check markdown internal links
    • validate_registry.py — validate registry table completeness
    • check_stats.py — check statistics and distribution

  • Example Configurations (references/)

    • perspective-config.example.yaml — complete annotated example
    • project-types-examples/ai-agent.example.yaml
    • project-types-examples/frontend.example.yaml
    • project-types-examples/backend.example.yaml

  • Security Checks — expanded from 18 to 27 checks

    • Added SEC_COMPLY_* (GDPR, HIPAA, PCI)
    • Added SEC_THREAT_* (data flow, trust boundaries, abuse cases)
    • Added SEC_ACCESS_* (RBAC, IDOR)

  • Performance Checks — expanded to 18 checks

    • Added PERF_LOAD_* (load tests, performance budgets)
    • Added PERF_DB_* (N+1, indexing, pagination)
    • Added PERF_NET_* (batching, caching, compression)

  • Testing Checks — expanded to 17 checks

    • Added TEST_STRAT_* (E2E, API contract, security negative tests)

Changed

  • Market Influence — renamed from "Market" perspective, scope clarified
  • Business Sustainability — new separate perspective from Market
  • Quick Scan / Full Scan — defined in project-types.md
  • Required / Optional / Type-Required — three-tier perspective classification formalized
  • Arbitration escalation — now has explicit 3-level escalation with timeframes

[1.0.0] — 2026-04-10

Added

  • Initial release
  • 19 Perspectives: User, Product, Project, Tech, Security, Performance, Testing, Integration, Observability, Documentation, i18n, Accessibility, Reliability, Cost Efficiency, Compatibility, Business/Compliance, Industry Vertical (placeholder), Market Influence, Business Sustainability
  • scoring-algorithm.md — unified scoring methodology
  • arbitration-rules.md — basic conflict resolution
  • user-interaction-protocol.md — Tier 1-3 confirmation flow
  • fix-action-registry.md — standardized fix action vocabulary
  • scanner-contract.md — scanner interface specification
  • scan-history/ — storage format and trend definition
  • project-types.md — project taxonomy and perspective weights
  • perspective-config-schema.md — complete config schema
  • auto-evolve-integration.md — integration guide

Deprecated Checks

Check ID Deprecated At Replaced By Sunset Date
SEC_DEP_OLD_001 2026-04-11 SEC_DEP_001 —
TEST_COV_LEGACY 2026-04-11 TEST_COV_001 —

Version Migration Notes

Upgrading from v1.0 to v1.1

  1. No breaking changes in v1.1
  2. All new checks are additive
  3. Existing scan results remain valid
  4. Run python3 scripts/check_stats.py to see the new check distribution
  5. Run python3 scripts/validate_check_ids.py to verify registry alignment