Skip to content

Commit 8ba200e

Browse files
docs(agents): fix a dependency's bug in the dependency, mark any workaround
1 parent e0e5eda commit 8ba200e

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,10 @@ Work waiting for the next breaking release uses one wording, in every file type:
167167
grep -rn "TODO in the next major release" codecov.yml bin hot lib setup test tooling
168168
```
169169

170+
### A dependency's bug is fixed in the dependency
171+
172+
When the root cause is in a dependency (`watchpack`, `enhanced-resolve`, `webpack-sources`, …), say so and name the fix it needs **before** writing code: that is the real fix, and a workaround in `lib/` hides it. Write a workaround only once the requester agrees, keep it the smallest bridge, and open its comment with `// WORKAROUND(<package>):` naming the gap, so `grep -rn "WORKAROUND(" lib` lists what to remove once the dependency ships its fix. Say so in the PR body too.
173+
170174
## Testing
171175

172176
Directory structure, naming and running one case: [TESTING_DOCS.md](TESTING_DOCS.md).

0 commit comments

Comments
 (0)