Skip to content

Instantly share code, notes, and snippets.

@supermarsx
Created September 7, 2025 10:39
Show Gist options
  • Save supermarsx/93a5cfe86fe79a68b9f255807e226b98 to your computer and use it in GitHub Desktop.
Save supermarsx/93a5cfe86fe79a68b9f255807e226b98 to your computer and use it in GitHub Desktop.
Codex CLI agents.md generation instruction/prompt

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

  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment