Skip to content
aiready-best-practices logo

AIReady Best Practices

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.

NeverSight/skills_feed0installs215stars

SKILL.md

Full skill instructions

AIReady Best Practices

Guidelines for writing code that AI coding assistants can understand and maintain effectively. Based on analysis of thousands of repositories and common AI model failure patterns.

When to Apply

Reference these guidelines when:

  • Writing new features - Apply patterns from the start
  • Reviewing pull requests - Check for AI-unfriendly patterns
  • Refactoring code - Improve AI comprehension
  • Debugging AI confusion - Fix when assistants give wrong suggestions
  • Preparing for AI adoption - Modernize codebase structure

Rule Categories by Priority

PriorityCategoryImpactPrefix
1Pattern DetectionCRITICALpatterns-
2Context OptimizationHIGHcontext-
3Consistency CheckingMEDIUMconsistency-
4DocumentationMEDIUMdocs-
5DependenciesLOWdeps-

Quick Reference

1. Pattern Detection (CRITICAL)

  • patterns-semantic-duplicates - Consolidate duplicate implementations
  • patterns-consistent-naming - Use consistent names for similar concepts
  • patterns-interface-fragmentation - Unify similar interfaces

2. Context Optimization (HIGH)

  • context-import-depth - Keep import chains shallow (max 3 levels)
  • context-cohesion - Group related functionality together
  • context-file-size - Split oversized files

3. Consistency Checking (MEDIUM)

  • consistency-naming-conventions - Follow project-wide naming patterns
  • consistency-error-handling - Use consistent error patterns
  • consistency-api-design - Maintain consistent API shapes

4. Documentation (MEDIUM)

  • docs-code-sync - Keep docs in sync with code changes
  • docs-ai-context - Document non-obvious AI context needs

5. Dependencies (LOW)

  • deps-circular - Avoid circular dependencies
  • deps-freshness - Keep dependencies up to date

How to Use

Read individual rule files for detailed explanations and code examples:

rules/​patterns-semantic-duplicates.md
rules/​context-import-depth.md
rules/​consistency-naming-conventions.md

Each rule file contains:

  • Brief explanation of why it matters for AI
  • Incorrect code example with explanation
  • Correct code example with explanation
  • Impact metrics and references

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md

Context Efficiency

This skill is designed for efficient context usage:

  • Lazy loading: Only relevant rules are loaded when needed
  • Progressive disclosure: Detailed examples are in separate files
  • Focused rules: Each rule addresses one specific pattern
  • Measurable impact: Clear metrics for each improvement

Related Tools

These guidelines complement the AIReady CLI tools:

  • @aiready/​pattern-detect - Automated semantic duplicate detection
  • @aiready/​context-analyzer - Context window cost analysis
  • @aiready/​consistency - Naming convention checking
  • @aiready/​cli - Unified analysis tool

Learn more: https://getaiready.dev

More skills from NeverSight

devops-deployer logo
NeverSight/skills_feed

devops-deployer

Comprehensive DevOps and deployment workflow that orchestrates infrastructure automation, CI/CD pipelines, container orchestration, and cloud deployment. Handles everything from infrastructure as code and pipeline setup to monitoring, scaling, and disaster recovery.

215 1
View
avnu logo
NeverSight/skills_feed

avnu

Integrate avnu SDK for Starknet DeFi: token swaps with best-price routing, DCA recurring buys, native staking, gasless transactions via paymaster, and market data. Use when building Starknet trading, DEX aggregation, or DeFi automation features.

215 0
View
post-to-x logo
NeverSight/skills_feed

post-to-x

发布内容和文章到 X (Twitter)。支持带图片的普通推文和 X Articles(长文)。使用真实的 Chrome 和 CDP 来绕过自动化检测。

215 0
View
ralph-prompt-builder logo
NeverSight/skills_feed

ralph-prompt-builder

Master orchestrator for generating Ralph Wiggum-compatible prompts. Analyzes task requirements and routes to appropriate generator (single-task, multi-task, project, or research). Use when you need to create any Ralph loop prompt and want automatic selection of the right generator.

215 0
View
branch-comparison logo
NeverSight/skills_feed

branch-comparison

Use when the user asks to compare branches, analyze git diffs, review changes between branches, update specifications based on code changes, or analyze what changed. Triggers on keywords like "compare branches", "git diff", "what changed", "branch comparison", "code changes", "spec update".

215 0
View
fastapi-development logo
NeverSight/skills_feed

fastapi-development

Build high-performance FastAPI applications with async routes, validation, dependency injection, security, and automatic API documentation. Use when developing modern Python APIs with async support, automatic OpenAPI documentation, and high performance requirements.

215 0
View
zendesk-chat logo
NeverSight/skills_feed

zendesk-chat

Enables Claude to manage Zendesk Chat conversations, support tickets, and customer service operations

215 0
View
forge logo
NeverSight/skills_feed

forge

Mine transcripts for knowledge - decisions, learnings, failures, patterns. Triggers: "forge insights", "mine transcripts", "extract knowledge".

215 0
View
mixpanel logo
NeverSight/skills_feed

mixpanel

Track product analytics and user behavior with Mixpanel's event-based platform.

215 0
View
ocpp logo
NeverSight/skills_feed

ocpp

OCPP protocol reference for EV charging infrastructure development. Covers OCPP 2.0.1 and OCPP 1.6J. Use when working with OCPP messages, charging station code, CSMS/Central System backends, smart charging, transaction handling, or EV charging protocols. Activates on keywords: OCPP, charging stat...

215 0
View
bee-collect logo
NeverSight/skills_feed

bee-collect

Gather scattered ideas into organized GitHub issues. The bee collects pollen from every flower, checks if the hive already has it, and carefully deposits new work in the comb for later. Never edits code—only organizes the work ahead. Use when creating issues from TODOs or planning work.

215 0
View
vercel-react-native-skills logo
NeverSight/skills_feed

vercel-react-native-skills

Comprehensive best practices for React Native and Expo applications. Contains rules across multiple categories covering performance, animations, UI patterns, and platform-specific optimizations.

215 0
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View