Skip to content

chore(tooling): the template ships 31 MB of this repository's own process, and strip does not remove it #259

Description

@koniz-dev

Context

Measured on main before this change:

lib/ 1.0 MB, 165 files
docs/verification/ 31 MB
total docs/ 32 MB

So 97% of the documentation this template ships is acceptance evidence about
issues closed in this repository. Someone who clicks "Use this template"
inherits 31 MB of logs about work they never saw.

The same applies to several guards. tool/check_epic_coverage.dart enforces
that every directory maps to an epic:* label; scripts/dev/check_issue_refs.sh
plus .github/workflows/issue-refs.yml require Refs koniz-dev/flutter-starter#N
in every commit and pull request body. A fork has neither epics nor this
repository's issue numbers, so those are not merely dead weight - the issue-refs
workflow would reject every pull request the adopter opens, and the epic tool
shells out to scripts/bootstrap-issue-labels.sh, so a fork's first
flutter test would go red.

The app code itself is not the problem and is not in scope here.

The rule this applies

A starter template proves the mechanism is correct; it does not prove the
product runs, and it does not carry the maintainer's own process. The test,
added to CLAUDE.md by this change:

Would an adopter notice if this were missing?

Yes -> it ships. No -> it belongs to this repository only, and the strip
variants should drop it.

Acceptance criteria

  1. dart run tool/strip_sample_features.dart --apply produces a tree with no
    docs/verification/, no tool/check_epic_coverage.dart, no
    scripts/dev/check_issue_refs.sh, no .github/workflows/issue-refs.yml,
    no .claude/agents/, no scripts/bootstrap-issue-labels.sh and no
    docs/issue-workflow.md. The same holds for --remove-tasks and
    --remove-feature-flags.
  2. Guards that protect the adopter's own app survive the strip:
    tool/check_env_assets.dart, tool/check_docs.dart,
    tool/doc_signatures.dart, tool/doc_symbols.dart, ci.yml,
    strip-smoke.yml and the git hooks.
  3. All three stripped trees pass flutter pub get, flutter analyze and
    flutter test cleanly, and dart run tool/check_docs.dart reports zero
    broken links on a stripped tree - nothing removed may leave a dangling
    reference.
  4. strip-smoke.yml asserts the removals actually happened. analyze and
    test stay green if the strip silently stops removing, so the assertion is
    what makes criterion 1 enforceable. Demonstrate it fails on an unstripped
    tree.
  5. Sections stripped from inside a file a fork keeps are marked in place
    rather than tracked by a second list that can rot. Unbalanced markers are a
    hard error reported before anything is deleted.
  6. Nothing is deleted from this repository - only the stripper learns to drop
    it. This repo keeps its own process.
  7. CLAUDE.md carries the scope test above, and it is itself marked
    process-only.
  8. ./scripts/dev/audit_template.sh exits 0.

No activity

Activity on this issue will appear here.

Activity

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

Metadata

Metadata

Assignees

Labels

epic:tooling-ci.github, .githooks, scripts/, tool/, bricks/, analyzer and pubspec configpriority:P2Normal queue: real but not blockingstatus:in-progressClaimed by an assignee and being worked right nowtype:taskChore, refactor, docs, or tooling work with no new capability

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions