You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a working guide for contributors and coding agents in this repository.
6
+
It captures practical rules that prevent avoidable CI and PR churn.
7
+
8
+
## Development Expectations
9
+
10
+
- If a public API changes, update the relevant docs in the same PR.
11
+
- If new types are made part of the public API, export them from the package's `index.ts` in the same PR.
12
+
- If new learnings or misunderstandings are discovered, propose an `AGENTS.md` update in the same PR.
13
+
- Tests should verify observable behavior changes, not only internal/config state.
14
+
- Example: for a security option, assert a real secure/insecure behavior difference.
15
+
16
+
## Permission and Escalation
17
+
18
+
-`npm install` requires escalated permissions for outbound network access to npm registries.
19
+
-`npm test` commands should b`e run with escalation so tests can access the Docker socket.
20
+
21
+
### Escalation hygiene
22
+
23
+
- Use specific commands and clear justifications.
24
+
- Prefer narrow reruns rather than broad full-suite reruns when iterating.
25
+
26
+
## PR Process
27
+
28
+
1. Start from `main`.
29
+
2. Create a branch prefixed with `codex/`.
30
+
3. Implement scoped changes only.
31
+
4. Run required checks: `npm run format`, `npm run lint`, and targeted tests.
32
+
5. Verify git diff only contains intended files. If changes are still being discussed, share the diff and get user approval before committing or pushing.
33
+
6. Commit with focused message(s), using `git commit --no-verify`.
34
+
7. Push branch. Ask for explicit user permission before any force push.
35
+
8. Open PR against `main` using a human-readable title (no `feat(...)` / `fix(...)` prefixes).
36
+
9. Before posting any comment on GitHub issues or PRs, share the proposed message with the user and get explicit approval.
37
+
10. Add labels for both change type and semantic version impact.
0 commit comments