Generalize lamport.md examples to be language-agnostic
- Changed Rust-specific examples to generic ones: - 'Tool calls must be valid JSON' → 'API responses must be valid JSON' - 'Never block the async runtime' → 'Never block the event loop' - 'Crate/module' → 'Module/package' - 'run cargo test' → 'basic commands'
This commit is contained in:
@@ -280,8 +280,8 @@ AGENTS.md should start with:
|
|||||||
REQUIRED sections (include ONLY these):
|
REQUIRED sections (include ONLY these):
|
||||||
|
|
||||||
1. **Critical Invariants**
|
1. **Critical Invariants**
|
||||||
- MUST hold constraints (e.g., "Tool calls must be valid JSON")
|
- MUST hold constraints (e.g., "API responses must be valid JSON", "Database connections must be closed")
|
||||||
- MUST NOT do constraints (e.g., "Never block the async runtime")
|
- MUST NOT do constraints (e.g., "Never block the event loop", "Never store secrets in logs")
|
||||||
- Performance constraints that affect correctness
|
- Performance constraints that affect correctness
|
||||||
|
|
||||||
2. **Recommended Entry Points**
|
2. **Recommended Entry Points**
|
||||||
@@ -305,10 +305,10 @@ REQUIRED sections (include ONLY these):
|
|||||||
|
|
||||||
DO NOT include in AGENTS.md:
|
DO NOT include in AGENTS.md:
|
||||||
- Architecture overview (use README)
|
- Architecture overview (use README)
|
||||||
- Crate/module descriptions (use README)
|
- Module/package descriptions (use README)
|
||||||
- File structure diagrams (derivable from codebase)
|
- File structure diagrams (derivable from codebase)
|
||||||
- Documentation links (use README's Documentation Map)
|
- Documentation links (use README's Documentation Map)
|
||||||
- Testing instructions beyond "run cargo test" (trivial)
|
- Testing instructions beyond basic commands (trivial)
|
||||||
- How to use the project (use README)
|
- How to use the project (use README)
|
||||||
|
|
||||||
------------------------------------------------------------
|
------------------------------------------------------------
|
||||||
|
|||||||
Reference in New Issue
Block a user