Skip to content

Comments

Add .github/copilot-instructions.md for AI agent onboarding#22

Merged
james0r merged 3 commits intomainfrom
copilot/add-copilot-instructions-file
Feb 13, 2026
Merged

Add .github/copilot-instructions.md for AI agent onboarding#22
james0r merged 3 commits intomainfrom
copilot/add-copilot-instructions-file

Conversation

Copy link
Contributor

Copilot AI commented Feb 13, 2026

Adds comprehensive onboarding documentation for AI coding agents working in this Shopify theme repository.

Changes

  • Created .github/copilot-instructions.md (410 lines) covering:

    • Project architecture: Vite + Tailwind v4 + Alpine.js + TypeScript + Liquid Ajax Cart v2
    • Repository structure and file purposes
    • Build/dev/deploy workflows and npm scripts
    • Alpine.js auto-registration pattern via import.meta.glob()
    • Path aliases (@/*, ~/*src/*)
    • Vite plugin stack and custom plugins
    • GitHub Actions workflows (theme-check, deploy-main)
  • Documented known issues with workarounds:

    • Missing assets folder warning on first build (expected)
    • 6 moderate npm vulnerabilities in dev dependencies (esbuild, lodash via @shopify/cli-kit)
    • Self-signed SSL certificate workflow for HTTPS dev server
    • Duplicate debounce functions in helpers.js
  • Common development patterns:

    • Alpine component/store registration conventions
    • Static asset handling via public/ directory
    • Liquid + Vite integration via auto-generated vite-tag.liquid

Key Technical Details

Shopify theme uses Vite plugin to map source entries to hashed assets:

{% liquid
  render 'vite-tag', entry: 'theme.css'
  render 'vite-tag', entry: 'theme.js'
  render 'vite-tag', entry: '@/js/prodify/index.ts'
%}

Alpine.js modules auto-register via glob imports in src/js/alpine/index.js, enabling drop-in components without manual registration.

MCP configuration (.mcp.json) enables programmatic Shopify dev tools access via @shopify/dev-mcp.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@james0r james0r marked this pull request as ready for review February 13, 2026 04:06
Copilot AI and others added 2 commits February 13, 2026 04:08
Co-authored-by: james0r <34731936+james0r@users.noreply.github.com>
Co-authored-by: james0r <34731936+james0r@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot instructions for onboarding Add .github/copilot-instructions.md for AI agent onboarding Feb 13, 2026
Copilot AI requested a review from james0r February 13, 2026 04:10
@james0r james0r merged commit d1fa979 into main Feb 13, 2026
1 of 2 checks passed
@james0r james0r deleted the copilot/add-copilot-instructions-file branch February 13, 2026 04:11
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.

2 participants