Choose Rust types for operating system paths in Codex server protocols and internal code. Guides new definitions and explicitly requested migrations while preserving client compatibility and handling paths from different operating systems.
Choose Rust types for operating system paths across the Codex repository. Use when defining new path-bearing types or explicitly migrating existing ones.
Review the instructions the agent will receive before you install.
Apply this guidance when defining new types. Change existing code only when explicitly requested, and keep edits minimal and proportional. Treat these rules as the target state of an ongoing migration; if compliance is difficult, ask the user how to proceed.
LegacyAppPathString for backwards compatibility during the URI
migration. At the protocol boundary, convert it to PathUri and use PathUri internally. For
host-local logic, such as some config values, use AbsolutePathBuf or PathBuf instead.PathUri. Internally, use PathUri or AbsolutePathBuf as
appropriate.PathUri or separate APIs that decouple their use
cases.Strings with feature-specific path handling code.Keep these requirements in mind while migrating code to conform with the above guidelines:
PathUri or LegacyAppPathString over local helpersPathUri values as URIs in diagnosticsIt is OK if the conversion between paths and URIs is somewhat lossy as long as it will do the right thing for real users.
Migrating to URIs should not add significant new failure modes. We will need to surface errors in some places that were previously infallible but it should be kept to a minimum.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Monitor a GitHub pull request for review feedback, automated check failures, and merge readiness. Diagnose failures, fix problems caused by the branch, and retry likely temporary failures while continuing to watch for updates.
Review external integration points for breaking changes that could disrupt existing use. Examine app-server APIs, command-line parameters, configuration loading, and session resumption from saved records, continuing beyond the first issue to cover possible failure paths.
Run a final pull request review using separate agents for each available review skill. Collect all reported issues into a numbered Markdown list, with a specific file path and line number for every finding.
Assess whether a code change is small enough to review using line-count guidance. For larger changes, examine the actual differences, dependencies, and calling code to suggest reviewable stages and the smallest coherent first step.
Review code that manages the conversation history and extra information sent to Codex models. Apply rules for incremental history, size limits, cache stability, manual review of large additions, and required implementation structures.
Plan and write tests for changes to agent behavior, favoring integration tests that check components together. Identify key logic changes and user-visible behavior to cover, reuse existing helpers, and keep unit tests in dedicated files.