Skip to content

Publish AGENTS.md and trim it to technical content - #523

Merged
rickdijk merged 1 commit into
chore/add-claude-mdfrom
chore/fpl-6-agents-md-technical
Sep 14, 2026
Merged

rickdijk merged 1 commit into
chore/add-claude-mdfrom
chore/fpl-6-agents-md-technical

Conversation

@rickdijk

Copy link
Copy Markdown
Contributor

✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)

Docs. Implements FPL-6.

Stacked on #522 (FPL-5), which FPL-6 is blocked by. Base retargets to develop once #522 merges.

⤵️ What is the current behavior?

Two problems.

AGENTS.md is git-ignored (6292965), so the best documentation in this repo is local to one checkout — absent from every clone and from CI, and CLAUDE.md's @AGENTS.md import resolves to nothing for anyone else.

It is also 205 lines mixing three different kinds of content: technical reference a contributor needs, process rules stated as prose an agent may or may not honour, and internal Baseflow strategy.

🆕 What is the new behavior (if this is a feature change)?

AGENTS.md is un-ignored and committed, then trimmed 205 → 188 lines, split by what each part does.

Stays — the technical reference that turns a stalled contributor into a merged PR: architecture overview, directory map, where-to-make-changes map, fork workflow, commands, testing expectations, platform notes, PR checklist.

Leaves, with a destination — nothing is deleted outright:

  • The "do not force-push / do not bump versions / do not commit unless asked" rules are parked verbatim on FPL-8, where they become PreToolUse hooks that block rather than advise.
  • The Notion link and internal Baseflow strategy are parked verbatim on FPL-12, bound for the private maintenance repo.

CLAUDE.md drops its note that the import is a no-op, which this change makes untrue.

The section order is chosen to be portable to octo_image and flutter_cached_network_image (FPL-10 / FPL-11 depend on this shape).

💥 Does this PR introduce a breaking change?

No. Documentation only — no package code is touched.

🐛 Recommendations for testing

The check that matters is that the import resolves for someone other than the author:

git clone --branch chore/fpl-6-agents-md-technical <repo> /tmp/probe
ls /tmp/probe/AGENTS.md    # present, 188 lines
head -1 /tmp/probe/CLAUDE.md    # @AGENTS.md

Verified locally: fresh clone contains both files. dart format --set-exit-if-changed . clean (56 files, 0 changed). flutter analyze reports 2 pre-existing use_super_parameters info lints in lib/src/web/web_helper.dart:242 and test/cache_manager_test.dart:626, both in files this PR does not touch.

📝 Links to relevant issues/docs

  • FPL-6 — the ticket this implements
  • FPL-8 — holds the hook-bound rules
  • FPL-12 — holds the private-repo-bound content
  • Reverses 6292965 ("Ignore local AGENTS.md agent instruction files")

🤔 Checklist before submitting

🤖 Generated with Claude Code

AGENTS.md was git-ignored (6292965), so "the best documentation anywhere
in this scope" was absent from every clone and from CI, and CLAUDE.md's
@AGENTS.md import resolved to nothing for anyone but the local checkout.
Un-ignore it and commit it.

Trim 205 lines to 188, splitting the content by what it does. Technical
reference stays: architecture, directory map, where-to-change map, fork
workflow, commands, testing expectations, platform notes, PR checklist.
Seven lines leave, each with a destination rather than a deletion:

* the "do not force-push / do not bump versions / do not commit unless
  asked" rules become PreToolUse hooks (FPL-8), where they block instead
  of being advice an agent may or may not honour
* the Notion link and internal Baseflow strategy move to the private
  maintenance repo (FPL-12)

Also drop CLAUDE.md's note that the import is a no-op, which this change
makes untrue.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@rickdijk
rickdijk merged commit 6e81977 into chore/add-claude-md Sep 14, 2026
@rickdijk
rickdijk deleted the chore/fpl-6-agents-md-technical branch September 14, 2026 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant