Skip to content

Commit 96f86f4

Browse files
Document monorepo workflow and safe gh PR body handling
1 parent 449b160 commit 96f86f4

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

AGENTS.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ It captures practical rules that prevent avoidable CI and PR churn.
2121
## Permission and Escalation
2222

2323
- `npm install` requires escalated permissions for outbound network access to npm registries.
24-
- `npm test` commands should b`e run with escalation so tests can access the Docker socket.
24+
- `npm test` commands should be run with escalation so tests can access the Docker socket.
2525

2626
### Escalation hygiene
2727

@@ -75,4 +75,14 @@ It captures practical rules that prevent avoidable CI and PR churn.
7575

7676
## Practical Note
7777

78+
- This repository is an npm workspaces monorepo:
79+
- root package: `testcontainers-monorepo`
80+
- workspaces: `packages/testcontainers` and `packages/modules/*`
81+
- shared lockfile: root `package-lock.json` (workspace installs update this single file)
82+
- When changing one workspace dependency, prefer targeted commands to reduce lockfile churn:
83+
- `npm install -w @testcontainers/<module>`
84+
- `npm uninstall -w @testcontainers/<module> <package>`
85+
- targeted tests via `npm run test -- <path-to-spec>`
7886
- Recheck `package-lock.json` after `npm install` for unrelated drift and revert unrelated changes.
87+
- When creating/editing PR descriptions with `gh`, do not inline backticks in shell command arguments.
88+
- Prefer `--body-file <path>` with a heredoc-written file to avoid shell command substitution.

0 commit comments

Comments
 (0)