Open
Conversation
Remove verbose development instructions, code style guidelines, and testing patterns that duplicate CLAUDE.md. Keep only the concise sections: identity, layering, core concepts, design principles, structural invariants, and development commands.
Single source of truth — both files now share the same content via symlink rather than maintaining two copies.
Contributor
Greptile SummaryThis PR consolidates agent guidance documentation by stripping
|
| Filename | Overview |
|---|---|
| AGENTS.md | Stripped from ~626 lines to ~46 lines, retaining only identity, layering, core concepts, design principles, structural invariants, and development commands. Notable guidance removed includes SPDX license header requirements, from __future__ import annotations, detailed code style/import rules, lazy loading patterns, testing patterns, and the key files reference list. |
| CLAUDE.md | Converted from a 3-line file using Claude Code's @AGENTS.md include directive to a proper filesystem symlink (git mode 120000) pointing to AGENTS.md, establishing a single source of truth. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["Claude Code reads CLAUDE.md"] -->|"symlink (git mode 120000)"| C["AGENTS.md\n(~46 lines)"]
B["Other agents read AGENTS.md"] --> C
C --> D["## Identity"]
C --> E["## The Layering Is Structural\nconfig → engine → interface"]
C --> F["## Core Concepts\nColumns / Samplers / Seed datasets / Processors / Models / Plugins"]
C --> G["## Core Design Principles\nDeclarative config · Registries · Error normalization"]
C --> H["## Structural Invariants\nImport direction · Fast imports · No relative imports · Typed · Tested"]
C --> I["## Development\nmake check-all-fix · make test · make update-license-headers · make perf-import"]
Last reviewed commit: 391c757
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.
Summary
AGENTS.mdfrom ~626 lines to ~48 lines, removing verbose development instructions, code style guidelines, and testing patterns that duplicateCLAUDE.mdCLAUDE.mda symlink toAGENTS.mdso there's a single source of truthCloses #430