Publish AGENTS.md and trim it to technical content - #523
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✨ 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
developonce #522 merges.Two problems.
AGENTS.mdis git-ignored (6292965), so the best documentation in this repo is local to one checkout — absent from every clone and from CI, andCLAUDE.md's@AGENTS.mdimport 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.mdis 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:
PreToolUsehooks that block rather than advise.CLAUDE.mddrops its note that the import is a no-op, which this change makes untrue.The section order is chosen to be portable to
octo_imageandflutter_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:
Verified locally: fresh clone contains both files.
dart format --set-exit-if-changed .clean (56 files, 0 changed).flutter analyzereports 2 pre-existinguse_super_parametersinfo lints inlib/src/web/web_helper.dart:242andtest/cache_manager_test.dart:626, both in files this PR does not touch.📝 Links to relevant issues/docs
🤔 Checklist before submitting
🤖 Generated with Claude Code