mirror of
https://github.com/openai/codex.git
synced 2026-04-26 07:35:29 +00:00
90f262e9a4
Introduce a full codex-tui source snapshot under the new codex-tui2 crate so viewport work can be replayed in isolation. This change copies the entire codex-rs/tui/src tree into codex-rs/tui2/src in one atomic step, rather than piecemeal, to keep future diffs vs the original viewport bookmark easy to reason about. The goal is for codex-tui2 to render identically to the existing TUI behind the `features.tui2` flag while we gradually port the viewport/history commits from the joshka/viewport bookmark onto this forked tree. While on this baseline change, we also ran the codex-tui2 snapshot test suite and accepted all insta snapshots for the new crate, so the snapshot files now use the codex-tui2 naming scheme and encode the unmodified legacy TUI behavior. This keeps later viewport commits focused on intentional behavior changes (and their snapshots) rather than on mechanical snapshot renames.
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
Generate a file named AGENTS.md that serves as a contributor guide for this repository.
|
||
Your goal is to produce a clear, concise, and well-structured document with descriptive headings and actionable explanations for each section.
|
||
Follow the outline below, but adapt as needed — add sections if relevant, and omit those that do not apply to this project.
|
||
|
||
Document Requirements
|
||
|
||
- Title the document "Repository Guidelines".
|
||
- Use Markdown headings (#, ##, etc.) for structure.
|
||
- Keep the document concise. 200-400 words is optimal.
|
||
- Keep explanations short, direct, and specific to this repository.
|
||
- Provide examples where helpful (commands, directory paths, naming patterns).
|
||
- Maintain a professional, instructional tone.
|
||
|
||
Recommended Sections
|
||
|
||
Project Structure & Module Organization
|
||
|
||
- Outline the project structure, including where the source code, tests, and assets are located.
|
||
|
||
Build, Test, and Development Commands
|
||
|
||
- List key commands for building, testing, and running locally (e.g., npm test, make build).
|
||
- Briefly explain what each command does.
|
||
|
||
Coding Style & Naming Conventions
|
||
|
||
- Specify indentation rules, language-specific style preferences, and naming patterns.
|
||
- Include any formatting or linting tools used.
|
||
|
||
Testing Guidelines
|
||
|
||
- Identify testing frameworks and coverage requirements.
|
||
- State test naming conventions and how to run tests.
|
||
|
||
Commit & Pull Request Guidelines
|
||
|
||
- Summarize commit message conventions found in the project’s Git history.
|
||
- Outline pull request requirements (descriptions, linked issues, screenshots, etc.).
|
||
|
||
(Optional) Add other sections if relevant, such as Security & Configuration Tips, Architecture Overview, or Agent-Specific Instructions.
|