Aiready best practices
Guidelines for writing AI-friendly code. Detects semantic duplicates, context fragmentation, naming inconsistencies. Use when writing new code, reviewing PRs, refactoring for AI adoption, or debugging AI assistant confusion. Helps minimize context waste and improve AI comprehension.From its SKILL.md
npx -y skills add getaiready/aiready-skills --skill aiready-best-practicesAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its file declares
Copied from the file, not written here
The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
1.8 KB, 273 tokens by cl100k_base, as published. Nobody here has run it
AIReady Best Practices
Guidelines for writing AI-friendly codebases that AI coding assistants can understand and maintain effectively. Based on analysis of thousands of repositories and common AI model failure patterns. Covers pattern detection, AI signal clarity, context optimization, change amplification, agent grounding, consistency checking, documentation, testability, and dependency management.
Core Capabilities
- AI Signal Clarity: Principles for reducing ambiguity in code.
- Context Optimization: Strategies for minimizing context window waste.
- Pattern Detection: Identifying and consolidating semantic duplicates.
- Consistency: Maintaining uniform naming and architectural patterns.
- Health Assessment: Using
aiready scanfor proactive codebase auditing.
Usage for Agents
Full instructions are available in AGENTS.md.
[!NOTE] AGENTS.md is automatically generated from individual rules in the
rules/directory. Contributors should modify the source rules rather than the compiled file.
Quick Commands (via npx)
- Measure Health:
npx @aiready/cli scan . - Check Consistency:
npx @aiready/cli consistency . - Detect Duplicates:
npx @aiready/cli patterns .
What ships with it: 23 files
64.8 KB alongside SKILL.md
rules/
- amplification-hotspots.md1.6 KB
- assessment-unified-scan.md1.3 KB
- consistency-error-handling.md1.7 KB
- consistency-naming-conventions.md1.5 KB
- context-cohesion.md1.6 KB
- context-file-size.md1.6 KB
- context-import-depth.md1.5 KB
- docs-code-sync.md1.4 KB
- grounding-context-boundaries.md1.4 KB
- grounding-readme-quality.md1.5 KB
- patterns-interface-fragmentation.md1.4 KB
- patterns-semantic-duplicates.md1.4 KB
- _sections.md2.8 KB
- signal-boolean-traps.md1.5 KB
- signal-magic-literals.md1.4 KB
- signal-naming-entropy.md1.5 KB
- signal-redundant-type-constants.md1.6 KB
- _template.md839 B
- testability-purity.md1.4 KB
- testability-verification.md1.5 KB
- AGENTS.md30.8 KB
- metadata.json553 B
- README.md3.2 KB