Skip to content

Add development standards documentation for theme components#47

Open
SmolSoftBoi wants to merge 5 commits intoShopify:mainfrom
m-k-enterprises:agents
Open

Add development standards documentation for theme components#47
SmolSoftBoi wants to merge 5 commits intoShopify:mainfrom
m-k-enterprises:agents

Conversation

@SmolSoftBoi
Copy link

Introduce comprehensive documentation outlining development standards and best practices for various theme components, including CSS, JavaScript, Liquid syntax, accessibility, and schema organization. This aims to enhance consistency and quality across theme development.

Copilot AI review requested due to automatic review settings February 7, 2026 12:52
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds discoverable development standards documentation entrypoints for Shopify theme components by introducing AGENTS.md files that link to the repo’s .cursor/rules/*.mdc standards.

Changes:

  • Add root-level AGENTS.md indexing standards across CSS/JS/Liquid/HTML and extensive accessibility topics.
  • Add directory-level AGENTS.md files (templates/sections/snippets/blocks/etc.) linking to the relevant rules.
  • (Accidentally) add a .DS_Store file to the repository.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
AGENTS.md Central index of development standards and accessibility rule references.
assets/AGENTS.md Pointer to asset standards rules.
blocks/AGENTS.md Pointer to block development and schema standards rules.
config/AGENTS.md Pointer to theme settings schema standards rules.
locales/AGENTS.md Pointer to locales/translation standards rules.
schemas/AGENTS.md Pointer to schema standards rules.
sections/AGENTS.md Pointer to section development and schema standards rules.
snippets/AGENTS.md Pointer to snippet/liquid standards rules.
templates/AGENTS.md Pointer to template (JSON) standards rules.
.DS_Store macOS metadata file added (should not be committed).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

SmolSoftBoi and others added 3 commits February 7, 2026 16:56
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


## Schema Standards

Liquid Rules: [Schema Standards](../.cursor/rules/schemas.mdc)
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link points to schemas.mdc, but it’s labeled as "Liquid Rules" here while schemas/AGENTS.md labels the same rule as "Rules". Consider using a consistent label across these docs (e.g., "Schema Rules" / "JSON Rules" / "Rules") to avoid confusion.

Suggested change
Liquid Rules: [Schema Standards](../.cursor/rules/schemas.mdc)
Rules: [Schema Standards](../.cursor/rules/schemas.mdc)

Copilot uses AI. Check for mistakes.
Comment on lines +33 to +34
## Accessibility

Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ## Accessibility heading is empty and the following ## Global Scope Accessibility Standards is at the same heading level, so the accessibility subsections aren’t actually grouped under the Accessibility section. Consider either removing the empty ## Accessibility header or making Global Scope Accessibility Standards (and the rest) a level deeper (e.g., ###) under it.

Suggested change
## Accessibility

Copilot uses AI. Check for mistakes.
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