Skip to content

Document pre-submit workflow and local dev (AGENTS.md + docs/LOCAL_DEV.md)#7734

Draft
dmerand wants to merge 3 commits into
donald/dx-pre-cifrom
donald/dx-docs
Draft

Document pre-submit workflow and local dev (AGENTS.md + docs/LOCAL_DEV.md)#7734
dmerand wants to merge 3 commits into
donald/dx-pre-cifrom
donald/dx-docs

Conversation

@dmerand
Copy link
Copy Markdown
Contributor

@dmerand dmerand commented Jun 5, 2026

WHY are these changes introduced?

Contributors and agents had no written guidance on getting a change green in CI, which checks to run before pushing, or local-dev conventions — all rediscovered per session. Agent instructions were also split across .claude/CLAUDE.md and .cursor/rules/ with no single entry point.

WHAT is this pull request doing?

  • AGENTS.md (root) is now the source of truth for agent/contributor instructions: it keeps the existing .cursor/rules references and adds the pre-submit workflow — pnpm pre-ci before pushing, pnpm codegen after command/flag/query changes, pnpm lint (not eslint <file>; CI lints project sources, not bin/), where custom lint rules live, and tests. Links CONTRIBUTING.md and docs/LOCAL_DEV.md.
  • .claude/CLAUDE.md becomes a symlink to ../AGENTS.md, so Claude and AGENTS.md-aware tools read the same file.
  • docs/LOCAL_DEV.md: setup via dev up, running the CLI, the local service env (SHOPIFY_SERVICE_ENV=local, SHOPIFY_CLI_NEVER_USE_PARTNERS_API=1), local admin URL mapping (fqdn.ts), and a theme-check pointer.

Docs only.

How to test your changes?

Read-through. Cited facts are verified in source: cli-kit env constants, the admin.shop.dev mapping in packages/cli-kit/src/public/node/context/fqdn.ts, and custom rules in packages/eslint-plugin-cli/rules/. Confirm Claude Code resolves the @.cursor/rules/* imports through the .claude/CLAUDE.md symlink.

Post-release steps

None.

@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Jun 5, 2026
Copy link
Copy Markdown
Contributor Author

dmerand commented Jun 5, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant