Skip to content

Add repo-audit profile for DungeonDex-style projects #1

Description

@keepithandy

Goal

Make dev-kit more useful as a reusable project-audit toolkit by adding a named audit profile for DungeonDex-style browser projects.

Current repo direction

dev-kit already presents itself as a Python command-line toolkit for read-only project audits and release hygiene. The README lists commands for audit, version, and report against a DungeonDex path.

Proposed work

  • Add a named audit profile such as browser-game-static or dungeondex.
  • Check for expected baseline files like VERSION.md, README.md, CHANGELOG.md, app entry files, and smoke scripts.
  • Keep checks read-only.
  • Make output friendly enough to paste into GitHub issues or release notes.

Acceptance checks

  • Running the profile does not modify the target repo.
  • Missing file checks report clear pass/fail messages.
  • Version-label checks still work.
  • Unit tests cover the profile selection path.
  • README documents the new profile command.

Guardrails

This should stay generic enough to help more than one project, even if DungeonDex is the first target.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions