Document pre-submit workflow and local dev (AGENTS.md + docs/LOCAL_DEV.md)#7734
Draft
dmerand wants to merge 7 commits into
Draft
Document pre-submit workflow and local dev (AGENTS.md + docs/LOCAL_DEV.md)#7734dmerand wants to merge 7 commits into
dmerand wants to merge 7 commits into
Conversation
github-actions
Bot
added
the
no-changelog
Contributor
Author
|
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.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
This was referenced Jun 5, 2026
dmerand
changed the base branch from
graphite-base/7734
to
donald/dx-pre-ci-affected
dmerand
force-pushed
the
donald/dx-pre-ci-affected
branch
from
867e4d4 to
ed599fc
Compare
dmerand
force-pushed
the
donald/dx-pre-ci-affected
branch
from
ed599fc to
ccde915
Compare
dmerand
force-pushed
the
donald/dx-pre-ci-affected
branch
from
ccde915 to
8b2b10a
Compare
dmerand
force-pushed
the
donald/dx-docs
branch
2 times, most recently
from
39dc774 to
d08090e
Compare
dmerand
force-pushed
the
donald/dx-pre-ci-affected
branch
from
8b2b10a to
6f30c6e
Compare
- AGENTS.md becomes a thin router into docs/ and .agents/skills - Move local-service-dev facts to docs/cli/local-development.md (indexed) - Fold pre-ci/codegen/check-ci-gates into get-started + CI contracts doc - Reconcile pnpm pre-ci (full parity) with cli-pre-submit-ci minimal-derived default - Remove orphan docs/LOCAL_DEV.md
…he gate manifest and pre-ci modes
dmerand
force-pushed
the
donald/dx-pre-ci-affected
branch
from
eb2d663 to
e96df11
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
About this stack
This stack came out of reviewing recent contributor and agent sessions in
Shopify/cli, where the same avoidable friction kept recurring: failures found only after pushing, generated files regenerated by hand, local checks drifting from what CI actually enforces, and setup conventions relearned every time. The goal is to make the local dev loop mirror CI and keep the two single-sourced so they can't drift — then document it so people and agents stop rediscovering it.WHY are these changes introduced?
There was no single place that told a contributor — or a coding agent — how to get a change green in CI, what to run before pushing, or the handful of local-dev conventions that everyone just sort of knew. People rediscovered the same things every time. This folds that guidance into the docs and skills we already have rather than starting a parallel set of files.
WHAT is this pull request doing?
AGENTS.md(root, and what.claude/CLAUDE.mdnow symlinks to) is a short entry point: it keeps the existing.cursor/rulesreferences, summarizes the pre-submit commands, and links out to the real material. It points rather than restates.docs/cli/local-development.mdis a new, indexed page (linked fromdocs/README.md) covering the local service environment (SHOPIFY_SERVICE_ENV=local,SHOPIFY_CLI_NEVER_USE_PARTNERS_API=1) and theadmin.shop.devmapping infqdn.ts.docs/cli/get-started.mdpicks uppnpm pre-ci,pre-ci:affected,codegen, andcheck-ci-gates, plus a note that CI lints package sources through Nx (not rootbin/)..agents/skills/_shared/shopify-cli-ci-repo-contracts.mddocuments the new commands, andcli-pre-submit-cinow leans on the gate manifest and frames the fast (pre-ci:affected) vs. full (pre-ci) checks.Docs only.
How to test your changes?
Read it through. The facts are checked against the source — the env vars in
cli-kit, theadmin.shop.devmapping inpackages/cli-kit/src/public/node/context/fqdn.ts, and the custom rules underpackages/eslint-plugin-cli/rules/— and every internal link resolves. Worth confirming on your side: that Claude Code follows the@.cursor/rules/*imports through the.claude/CLAUDE.mdsymlink.Post-release steps
None.
Smoke-testing
Validated with a fresh-agent A/B — the same task run with and without this stack:
cli-pre-submit-ciskill first and gave correct, staging-aware guidance (regenerate + commit, the right checks) in a handful of tool calls.docs/cli/local-development.mdand answered in ~11s, versus ~8 minutes of source-grepping for the same question onmain. It also confirmed theAGENTS.mdrouting (via the.claude/CLAUDE.mdsymlink) resolves.