Skip to content

feat(showcase): implement the 'Cougr Verified' badge check #258

Description

@salazarsebas

Part of #240

Background

The showcase needs a credible trust signal, otherwise it is just a list. EXAMPLE_STANDARD.md already defines exactly what "canonical" means (module layout, README structure, dependency hygiene, testing categories) and scripts/enforce_hygiene.sh already implements much of that check programmatically. docs/strategy/05-ecosystem-vision.md proposes formalizing this into a visible "Cougr Verified" badge, reusing existing logic rather than inventing a new standard.

Objective

Implement an automated check that evaluates an example against the existing EXAMPLE_STANDARD.md checklist and produces a pass/fail "Cougr Verified" status that the showcase (sibling sub-issue) renders as a badge.

References

  • EXAMPLE_STANDARD.md (the checklist this issue automates, not redefines)
  • scripts/enforce_hygiene.sh (existing partial implementation to extend, not replace)
  • Dependency: the cougr check CLI command (CLI epic) is the natural home for this logic if that epic lands first; if not, this issue may implement it standalone and the CLI epic should later consume it, avoid building two divergent implementations of the same checklist.

In scope

  1. A checklist runner (reusing cougr check from the CLI epic if available, or standalone otherwise) that evaluates a given example directory against every criterion in EXAMPLE_STANDARD.md's canonical-vs-transitional checklist.
  2. Output format the gallery generator can consume directly (e.g. a pass/fail plus a list of unmet criteria, written to the catalog metadata or a sibling report file).
  3. Run against all 10 currently-canonical examples as a validation pass; all 10 must pass (if any doesn't, that's a signal worth raising, not silently working around).
  4. Wired into CI so a canonical example that regresses against the standard is caught automatically, not just at showcase-build time.

Out of scope

Definition of done

  • Running the check against all 10 canonical examples produces 10 passes.
  • Running the check against a deliberately non-compliant fixture produces a specific, correct list of failing criteria.
  • The check runs in CI, not only on demand.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programadvancedRequires deep Cougr knowledgeenhancementNew feature or requestshowcasePublic example showcase / gallery

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions