Skip to content

update shopify theme requirements #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 16, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/tools/shopify-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,31 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

[Shopify CLI](https://github.com/Shopify/cli) is a command-line tool that helps you build Shopify apps, themes, and custom storefronts. It provides functionality for initializing, building, developing, and deploying Shopify projects.

## Requirements

The tool only runs when the following conditions are met:

### File Types

- Only processes pull requests changing `*.liquid` files

### Configuration Files

- Requires either `.theme-check.yml` or `.theme-check.yaml` configuration file in the project root

### Directory Structure

- Requires the standard Shopify theme directory structure at the project root:
- `assets/`
- `config/`
- `layout/`
- `locales/`
- `sections/`
- `snippets/`
- `templates/`

If any of these requirements are not met, the tool will not run.

## Validation Rules

The tool checks for:
Expand Down