Repository navigation
Clarify contributor and agent guidance from PR feedback - #8744
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation-only changes consistently capture the cited feedback and use valid repository references.
Review effort: Balanced
Findings: None
What changed in this PR
Consolidates recurring PR feedback into contributor and agent guidance without changing CLI behavior.
Changes:
- Clarifies cache identity, resource cleanup, I/O, diagnostics, recovery, and performance guidance.
- Strengthens regression-testing and command-flag testing expectations.
- Improves guide discovery and supported-tooling instructions.
| File | Description |
|---|---|
AGENTS.md |
Adds task-oriented guide descriptions and clearer agent rules. |
.agents/automated-tasks/performance.md |
Moves performance evidence from code comments to PRs. |
.agents/automated-tasks/security.md |
Clarifies secure path-containment validation. |
docs/README.md |
Repairs plugin guidance links. |
docs/cli/conventions.md |
Documents cache, resource, I/O, and observability conventions. |
docs/cli/cross-os-compatibility.md |
Updates supported Node and PNPM setup. |
docs/cli/debugging.md |
Adds diagnostic redaction guidance. |
docs/cli/error_handling.md |
Clarifies narrow recovery and retry handling. |
docs/cli/get-started.md |
References authoritative runtime versions. |
docs/cli/performance.md |
Adds measurement and concurrency guidance. |
docs/cli/testing-strategy.md |
Strengthens regression and cleanup testing guidance. |
docs/cli-kit/command-guidelines.md |
Adds dependent-flag testing guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
dmerand
marked this pull request as ready for review
October 2, 2026 20:06
isaacroldan
approved these changes
Oct 5, 2026
| Tests can be run with `pnpm test` for the Vitest suite, `pnpm test:watch` for watch mode, or `pnpm test:e2e` for the Playwright end-to-end suite. If you want to run a single unit test, pass the path to the file as argument: | ||
| - `pnpm test`: run the Vitest suite. | ||
| - `pnpm exec vitest`: run Vitest in watch mode. | ||
| - `pnpm test:e2e`: run the Playwright end-to-end suite. |
Contributor
There was a problem hiding this comment.
This is not enough, you need some env variables that are explained here: https://vault.shopify.io/teams/2238-DevTools/docs/dev-platform/cli/Testing#test-credentials
What about adding a link?
Contributor
Author
There was a problem hiding this comment.
I'll follow up with a fix.
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
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.
WHY are these changes introduced?
PR feedback includes repeated corrections for resource cleanup, cache identity, and regression test inputs. These examples come from a review of available feedback from 2 April to 2 October 2026.
Some expectations are already documented but need clearer links. Other guidance needs more detail. Keep the added details in existing guides so contributors and agents have one place to find each rule.
WHAT is this pull request doing?
Keep the existing guide list in
AGENTS.mdand explain when to read each page. Clarify guidance for cache validity, resource cleanup, file IO, error recovery, diagnostics, performance, and regression tests.This changes documentation and agent instructions, not the CLI implementation.
How to manually test your changes?
AGENTS.mdguide list. Follow the links for CLI, CLI kit, and UI kit work.Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add