|
| 1 | +Generate a file named AGENTS.md that serves as a contributor guide for this repository. |
| 2 | +Your goal is to produce a clear, concise, and well-structured document with descriptive headings and actionable explanations for each section. |
| 3 | +Follow the outline below, but adapt as needed — add sections if relevant, and omit those that do not apply to this project. |
| 4 | + |
| 5 | +Document Requirements |
| 6 | + |
| 7 | +- Title the document "Repository Guidelines". |
| 8 | +- Use Markdown headings (#, ##, etc.) for structure. |
| 9 | +- Keep the document concise. 200-400 words is optimal. |
| 10 | +- Keep explanations short, direct, and specific to this repository. |
| 11 | +- Provide examples where helpful (commands, directory paths, naming patterns). |
| 12 | +- Maintain a professional, instructional tone. |
| 13 | + |
| 14 | +Recommended Sections |
| 15 | + |
| 16 | +Project Structure & Module Organization |
| 17 | + |
| 18 | +- Outline the project structure, including where the source code, tests, and assets are located. |
| 19 | + |
| 20 | +Build, Test, and Development Commands |
| 21 | + |
| 22 | +- List key commands for building, testing, and running locally (e.g., npm test, make build). |
| 23 | +- Briefly explain what each command does. |
| 24 | + |
| 25 | +Coding Style & Naming Conventions |
| 26 | + |
| 27 | +- Specify indentation rules, language-specific style preferences, and naming patterns. |
| 28 | +- Include any formatting or linting tools used. |
| 29 | + |
| 30 | +Testing Guidelines |
| 31 | + |
| 32 | +- Identify testing frameworks and coverage requirements. |
| 33 | +- State test naming conventions and how to run tests. |
| 34 | + |
| 35 | +Commit & Pull Request Guidelines |
| 36 | + |
| 37 | +- Summarize commit message conventions found in the project’s Git history. |
| 38 | +- Outline pull request requirements (descriptions, linked issues, screenshots, etc.). |
| 39 | + |
| 40 | +(Optional) Add other sections if relevant, such as Security & Configuration Tips, Architecture Overview, or Agent-Specific Instructions. |
0 commit comments