NetFabric/NetFabric.Numerics / .agents/skills/agents-md
agents-md
VerifiedAuthor and maintain AGENTS.md files — the open, tool-agnostic format for giving coding agents project context. Use when: creating AGENTS.md; writing an agent instructions file; root or nested AGENTS.md for monorepos; migrating CLAUDE.md, AGENT.md, .cursor/rules, or copilot-instructions.md to AGENTS.md; greenfield project setup before code exists; brownfield onboarding for an existing codebase; documenting build/test/lint commands, code style, PR/commit conventions, and security considerations for agents; AGENTS.md discovery and precedence rules. Works for any language, framework, or project size. DO NOT USE FOR: authoring SKILL.md skill files (use create-skill); APM package/plugin authoring (use apm-producer); language-specific style rules (use language skills e.g. csharp-best-practices).
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 3.4 KB |
| references/anatomy-and-discovery.md | markdown | 3.2 KB |
| references/authoring-workflow.md | markdown | 4.5 KB |
| references/quality-and-security.md | markdown | 2.2 KB |
| references/writing-style.md | markdown | 2.0 KB |
references/writing-style.md
View on GitHub# Writing Style
`AGENTS.md` is re-read into context on every task, same as a skill — apply the same compact, table-driven style, with zero loss of accuracy.
## Core Rules
| Rule | Do | Don't |
| --- | --- | --- |
| Executable over descriptive | "Run `pnpm test`" | "Make sure tests pass" |
| Tables > prose | Bullet/table a list of commands or conventions | Multi-sentence paragraphs for scannable facts |
| No preamble | Start with the first section heading | "This file describes how to work in this repo..." |
| Active voice, short sentences | "Run `X` before committing" | "`X` should be run by contributors before changes are committed" |
| Link, don't duplicate | Link to README/CONTRIBUTING for human-facing content | Copy full README prose into `AGENTS.md` |
| Concrete over aspirational | Document what the repo's tooling actually does today | Describe a style guide nobody enforces |
| Concise over exhaustive | Short, scannable sections | A wall of prose an agent must re-parse every run |
| Nest instead of bloat | Per-package `AGENTS.md` for monorepos | One giant root file covering every package |
| Mermaid diagrams | Flow/sequence/graph when structure is clearer and more compact than prose or a table | Diagrams for data that fits cleanly in a table |
Compactness never trims a command, a flag, or a caveat that changes behavior — cut words, not facts.
## Section Length Guidance
| Section | Target |
| --- | --- |
| Project overview | 1 paragraph |
| Each list section (setup, build, code style) | 3-8 bullets |
| Whole file (single-package repo) | Fits on one screen; split into nested files before it doesn't |
## Anti-Patterns
- ❌ Multi-sentence paragraphs where a table or bullet list would do
- ❌ Preamble ("This file describes...", "Note that...") before the first heading
- ❌ Copying the entire README/CONTRIBUTING.md verbatim instead of linking to it
- ❌ Describing a convention aspirationally instead of what the tooling actually enforces today
- ❌ One monolithic root file for a large monorepo instead of nested per-package files
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |