Skip to content

PR #2114: Fix Mermaid Accessibility & README Validation Failures #2226

Description

@ashleyshaw

[BUG] PR #2114: Fix Mermaid Accessibility & README Validation Failures

Summary

PR #2114 attempts to address Mermaid diagram accessibility and README frontmatter validation failures, but the PR itself has multiple CI failures and missing template sections that prevent merge.

Definition of Ready (DoR)

Critical Issues Found

1. Missing npm Scripts ✅ FIXED

  • Status: Fixed
  • Root Cause: CI workflow invokes npm run validate:branch-name, npm run validate:issue-fields, etc. but scripts are not defined in package.json
  • Solution: Add missing script definitions to package.json
  • Files Modified: package.json

2. Mermaid Diagram Validation ⏳ PENDING

  • Status: Requires verification in CI
  • Issue: Accessibility check and colour contrast check failed
  • Solution: Ensure changed-files-list handling works correctly

3. README Frontmatter Validation ⏳ PENDING

  • Status: Requires verification in CI
  • Issue: README.md files have frontmatter validation issues
  • Solution: Ensure frontmatter validator properly targets changed files only

4. PR Template Enforcement ✅ FIXED

  • Status: Updated with all required sections
  • Solution: Linked issues reference and DoD checklist added

Definition of Done (DoD)

  • All missing npm scripts added to package.json
  • PR rebased against latest develop
  • All CI checks pass (linting, validation, tests)
  • Mermaid accessibility & contrast validation passes
  • README frontmatter validation passes
  • PR template complete with all required sections
  • PR has proper labels
  • Code review feedback addressed
  • Issue closed when PR is merged

Success Criteria

  • All missing npm scripts defined in package.json
  • All CI checks pass
  • PR can be merged without conflicts

Links

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

Fields

Priority

None yet

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions