Skip to content

Commit ec7efdb

Browse files
committed
docs: add LLM contribution guidance to AGENTS.md
1 parent b5c5e21 commit ec7efdb

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ This file provides guidance to agents when working with code in this repository.
44

55
- Settings View Pattern: When working on `SettingsView`, inputs must bind to the local `cachedState`, NOT the live `useExtensionState()`. The `cachedState` acts as a buffer for user edits, isolating them from the `ContextProxy` source-of-truth until the user explicitly clicks "Save". Wiring inputs directly to the live state causes race conditions.
66

7+
## LLM-Assisted Contribution Guidance
8+
9+
Before implementing a non-trivial change, decompose it into the smallest independently reviewable slices you can.
10+
11+
- One independently reviewable unit per PR. A PR should be understandable, testable, and mergeable on its own without the next PR.
12+
- Prefer stacked draft PRs over one large PR when a change naturally builds in layers. Link dependent PRs and keep them small.
13+
- Separate refactors from behavior changes. If a change both restructures code and adds or fixes user-visible behavior, land the preparatory refactor first.
14+
- "Tightly coupled" is not enough reason to bundle everything together. Shared files or runtime coupling do not automatically mean the work belongs in one PR.
15+
- Use this test when deciding whether work must stay together: if PR A can merge without leaving the repository broken or degraded while PR B waits, they should usually be separate PRs.
16+
- When the decomposition is unclear, pause before coding and propose the split in the issue or in a draft PR.
17+
718
## Test Placement Guidance
819

920
Prefer the narrowest test layer that proves the behavior. This follows standard test-pyramid guidance: keep most coverage in fast, focused tests; add integration tests for cross-module contracts; reserve end-to-end tests for full workflow confidence.

0 commit comments

Comments
 (0)