Skip to content

Record upkeep rules for a11y manifest #1158

Description

@greatest0fallt1me

Summary

src/data/a11y-manifest.json drives the A11yAudit page, but nothing explains when to add a component, what statuses mean or who updates it.

Why this matters

The board goes stale as soon as components are added without manifest entries.

Scope

Add a docs section describing manifest fields, status definitions (audited, needs-work, n/a), and a PR checklist item to update the manifest for new components.

Relevant code in CalloraOrg/Callora-Frontend:

  • src/data/a11y-manifest.json
  • src/pages/A11yAudit.tsx
  • CONTRIBUTING.md

Priority

Low

Acceptance criteria

  • Manifest fields are documented
  • Status definitions are precise
  • CONTRIBUTING includes the manifest update step
  • The A11yAudit page links to the doc

Validation

Doc review; npm test -- --run passes.

Non-goals

  • Typo-only, formatting-only, or cosmetic changes.
  • Unrelated refactors, dependency upgrades, or broad rewrites.
  • Removing safeguards or weakening validation to make tests pass.

Contributor application

Before coding, describe the affected modules, proposed state/invariant changes, test strategy, compatibility considerations, and an estimate. Wait for assignment before starting implementation.

PR requirements

Use a feature branch and include Closes #<issue-number>. Address every criterion, map criteria to code and tests, explain security and failure-mode handling, and ensure CI passes.

Quality review

A maintainer will assess correctness, completeness, test depth, compatibility, observability, and adverse-case handling. A substantive implementation is required; merge or CI status alone does not guarantee reward eligibility.


Generated by Claude Code

Activity

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

Metadata

Metadata

Labels

Stellar WaveStellar Wave Program issue

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions