-
Notifications
You must be signed in to change notification settings - Fork 0
docs: refresh Codex context contract #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,34 @@ | ||
| <!-- codex-os-managed --> | ||
| ## What | ||
|
|
||
| Brief description of the changes. | ||
| - | ||
|
|
||
| ## Why | ||
|
|
||
| Why is this change needed? | ||
| - | ||
|
|
||
| ## How | ||
| - | ||
|
|
||
| ## Testing | ||
| - Commands run: | ||
| - Results: | ||
|
|
||
| ## Performance impact | ||
| - Bundle delta: | ||
| - Build time delta: | ||
| - Lighthouse delta: | ||
| - API latency delta: | ||
| - DB query delta: | ||
|
|
||
| ## Risk / Notes | ||
| - | ||
|
|
||
| How were the changes implemented? Any design decisions worth noting? | ||
| ## Screenshots (UI only) | ||
| - | ||
|
|
||
| ## Checklist | ||
| ## Lockfile rationale (if lockfile changed) | ||
| - | ||
|
|
||
| - [ ] Tests pass | ||
| - [ ] No new warnings | ||
| - [ ] Documentation updated (if applicable) | ||
| ## Baseline governance (if .perf-baselines changed) | ||
| - `perf-baseline-update` label applied: | ||
| - Reviewer signoff: | ||
| - Rollback note: |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,14 @@ | ||
| ## Definition of Done: Tests + Docs (Blocking) | ||
| # AGENTS.md | ||
|
|
||
| <!-- comm-contract:start --> | ||
|
|
||
| ## Communication Contract (Global) | ||
| ## Communication Contract | ||
|
|
||
| - Follow `/Users/d/.codex/policies/communication/BigPictureReportingV1.md` for all user-facing updates. | ||
| - Use exact section labels from `BigPictureReportingV1.md` for default status/progress updates. | ||
| - Keep default updates beginner-friendly, big-picture, and low-noise. | ||
| - Keep technical details in internal artifacts unless explicitly requested by the user. | ||
| - Honor toggles literally: `simple mode`, `show receipts`, `tech mode`, `debug mode`. | ||
| - Inherit global Codex communication and reporting rules from `/Users/d/.codex/AGENTS.override.md` and `/Users/d/.codex/policies/communication/BigPictureReportingV1.md`. | ||
| - Repo-specific instructions below add project constraints only; do not restate global voice or status-reporting rules here. | ||
| <!-- comm-contract:end --> | ||
| - Any production code change must include meaningful test updates in the same PR. | ||
| - Meaningful tests must include at least: | ||
| - one primary behavior assertion | ||
| - two non-happy-path assertions (edge, boundary, invalid input, or failure mode) | ||
| - Trivial assertions are forbidden (`expect(true).toBe(true)`, snapshot-only without semantic assertions, render-only smoke tests without behavior checks). | ||
| - Mock only external boundaries (network, clock, randomness, third-party SDKs). Do not mock the unit under test. | ||
| - UI changes must cover state matrix: loading, empty, error, success, disabled, focus-visible. | ||
| - API/command surface changes must update generated contract artifacts and request/response examples. | ||
| - Architecture-impacting changes must include an ADR in `/docs/adr/`. | ||
| - Required checks are blocking when `fail` or `not-run`: lint, typecheck, tests, coverage, diff coverage, docs check. | ||
| - Reviewer -> fixer -> reviewer loop is required before merge. | ||
|
|
||
| ## Inherited Operating Rules | ||
|
|
||
| - Inherit global git, review/fix, testing, docs, UI, skill-use, and reporting gates from `/Users/d/.codex/AGENTS.md` and active session instructions. | ||
| - Add repo-specific constraints here only when this project has instructions that differ from global Codex defaults. | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When this repo is used outside the author's workstation, this absolute
/Users/d/.codex/AGENTS.mdreference is not available, so the explicit blocking test/docs/reviewer-loop requirements that were deleted above no longer reach Codex agents. I checked this workspace and the referenced/Users/d/.codex/...files are absent, which means a normal checkout loses the repo's Definition of Done instead of inheriting it; either keep those requirements in this file or reference a repo-tracked path.Useful? React with 👍 / 👎.