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.
1---2name: init3description: Init4---56Generate a file named AGENTS.md that serves as a contributor guide for this repository.7Your goal is to produce a clear, concise, and well-structured document with descriptive headings and actionable explanations for each section.8Follow the outline below, but adapt as needed — add sections if relevant, and omit those that do not apply to this project.910Document Requirements1112- Title the document "Repository Guidelines".13- Use Markdown headings (#, ##, etc.) for structure.14- Keep the document concise. 200-400 words is optimal.15- Keep explanations short, direct, and specific to this repository.16- Provide examples where helpful (commands, directory paths, naming patterns).17- Maintain a professional, instructional tone.1819Recommended Sections2021Project Structure & Module Organization2223- Outline the project structure, including where the source code, tests, and assets are located.2425Build, Test, and Development Commands2627- List key commands for building, testing, and running locally (e.g., npm test, make build).28- Briefly explain what each command does.2930Coding Style & Naming Conventions3132- Specify indentation rules, language-specific style preferences, and naming patterns.33- Include any formatting or linting tools used.3435Testing Guidelines3637- Identify testing frameworks and coverage requirements.38- State test naming conventions and how to run tests.3940Commit & Pull Request Guidelines4142- Summarize commit message conventions found in the project’s Git history.43- Outline pull request requirements (descriptions, linked issues, screenshots, etc.).4445(Optional) Add other sections if relevant, such as Security & Configuration Tips, Architecture Overview, or Agent-Specific Instructions.
plurigrid