Skip to content

Conversation

@youknownix
Copy link

@youknownix youknownix commented Dec 26, 2025

Summary

  • Add CLAUDE.md for Claude Code integration
  • Add AGENTS.md for general AI coding assistants (Cursor, GitHub Copilot, etc.)

What these files provide

Both files give AI assistants project-specific context:

Section Description
Project overview Core principles (web-native, server-rendered, zero dependencies)
Development commands shopify theme check, npm run build:schemas, shopify theme dev
Architecture Directory structure, component hierarchy (sections → blocks → snippets)
Critical rules Conditional schema editing workflow, single content_for 'blocks' rule, snippet documentation
Code standards Liquid, JavaScript, CSS, and accessibility guidelines
Key files Component base class, global styles, settings schema locations

Why two files?

  • CLAUDE.md — Recognized by Claude Code CLI, Anthropic's official coding assistant
  • AGENTS.md — Generic convention recognized by multiple AI coding tools (Cursor, Windsurf, etc.)

Both files have identical content to ensure consistent behavior across different AI tools.

Benefits for contributors

  • Reduces onboarding time for AI-assisted development
  • Prevents common mistakes (e.g., editing schemas directly when a build system exists)
  • Ensures AI-generated code follows Horizon's conventions
  • Improves PR quality and reduces review cycles

No impact on theme publishing

These root-level markdown files are excluded from theme packages:

  • shopify theme package only includes standard theme directories: assets/, blocks/, config/, layout/, locales/, sections/, snippets/, templates/
  • Files outside these directories are not uploaded to Shopify
  • No effect on merchant stores, theme functionality, or performance
  • No changes to theme review eligibility

References

Test plan

  • shopify theme check passes with no new errors
  • shopify theme package generates ZIP without these .md files
  • Existing theme functionality unaffected

@youknownix youknownix marked this pull request as ready for review December 26, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant