Skip to content

Commit d57b735

Browse files
volsaclaude
andauthored
docs: Update AGENTS.md (#1754)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 52c21a6 commit d57b735

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,7 @@ fn get_base(node: &AstNode) -> plc_source::source_location::SourceLocation { ...
8080
// Good
8181
fn get_base(node: &AstNode) -> SourceLocation { ... }
8282
```
83+
84+
7. No phase references in code. Never write "Phase 1", "for now", "later phase", or similar roadmap labels in source, doc comments, or tests — those belong in PLAN.md, PRs, or issues. If a type or function is intentionally incomplete, describe *what* is incomplete (e.g. "inner content is captured opaquely") rather than tying it to a numbered phase.
85+
86+
8. No assumed reference files in finalized code. Never `include_str!`/`include_bytes!` paths that traverse out of the crate, write doc comments that point at files outside the crate (e.g. "mirrors path/to/schema.xsd"), or read test fixtures from sibling directories — fixtures live in the crate's own `tests/fixtures/`. External specs, vendor schemas, and sample inputs are reference-only and must not be load-bearing for build, test, or docs.

0 commit comments

Comments
 (0)