Add root CLAUDE.md importing local AGENTS.md - #522
Merged
Merged
Conversation
Claude Code reads CLAUDE.md, not AGENTS.md, so import the (git-ignored, local) AGENTS.md from it and keep only Claude-specific notes here: FVM usage, file-tool preferences, review slash commands, and commit/PR attribution. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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>
4 tasks done
Publish AGENTS.md and trim it to technical content
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
1 participant
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 / tooling. Adds a root
CLAUDE.mdfor contributors using Claude Code.Agent guidance lives in
AGENTS.md. Claude Code does not readAGENTS.md— the documentation is explicit that it readsCLAUDE.md, and there is no setting to add other context filenames — so every Claude Code session in this repo starts with no project guidance at all, silently and with no warning.🆕 What is the new behavior (if this is a feature change)?
CLAUDE.mdis added at the repo root. It does two things:AGENTS.mdvia@AGENTS.md, so all tool-neutral guidance stays in one place and is not duplicated.lib/src/web/andlib/src/storage/changes, and the commit/PR attribution lines.Note on sequencing: at the time this PR was opened,
AGENTS.mdwas git-ignored, which made the@AGENTS.mdimport a no-op in a fresh clone and in CI. That is fixed in the follow-up PR, which un-ignores and commitsAGENTS.md— merge that one for the import to actually resolve for anyone but the local checkout.💥 Does this PR introduce a breaking change?
No. Documentation only — no package code is touched.
🐛 Recommendations for testing
Nothing to test.
flutter_cache_manager/CHANGELOG.mdgains one## [Unreleased]entry.📝 Links to relevant issues/docs
🤔 Checklist before submitting
🤖 Generated with Claude Code