|
| 1 | +--- |
| 2 | +name: init |
| 3 | +version: 1.0.0 |
| 4 | +description: | |
| 5 | + Generate an AGENTS.md contributor guide for the current repository. |
| 6 | + Use when the user wants to create repository guidelines, initialize a project |
| 7 | + for AI-assisted development, or when they run the /init command. |
| 8 | +--- |
| 9 | + |
| 10 | +# Repository initialization |
| 11 | + |
| 12 | +Create an AGENTS.md file that serves as a contributor guide for AI agents working in this repository. |
| 13 | + |
| 14 | +## Instructions |
| 15 | + |
| 16 | +1. **Analyze the repository** by examining: |
| 17 | + - Project structure (directories, key files) |
| 18 | + - Build configuration (package.json, Makefile, Cargo.toml, etc.) |
| 19 | + - Existing documentation (README, CONTRIBUTING, etc.) |
| 20 | + - Git history for commit message conventions |
| 21 | + - Test setup and configuration |
| 22 | + - Linting and formatting tools |
| 23 | + |
| 24 | +2. **Create AGENTS.md** in the repository root with these sections: |
| 25 | + |
| 26 | +### Document requirements |
| 27 | + |
| 28 | +- Title it "Repository Guidelines" |
| 29 | +- Use markdown headings for structure |
| 30 | +- Keep it concise: 200-400 words is optimal |
| 31 | +- Be specific to this repository, not generic advice |
| 32 | +- Include concrete examples (commands, paths, patterns) |
| 33 | + |
| 34 | +### Recommended sections |
| 35 | + |
| 36 | +**Project Structure & Module Organization** |
| 37 | +- Describe the high-level organization (e.g., "monorepo with apps/ and packages/") |
| 38 | +- Mention key entry points, not exhaustive file listings |
| 39 | +- Avoid detailed file trees that will become outdated |
| 40 | +- Focus on patterns and conventions, not current state |
| 41 | + |
| 42 | +**Build, Test, and Development Commands** |
| 43 | +- How to install dependencies |
| 44 | +- How to run tests |
| 45 | +- How to build the project |
| 46 | +- How to run locally (if applicable) |
| 47 | + |
| 48 | +**Coding Style & Naming Conventions** |
| 49 | +- Indentation (tabs vs spaces, width) |
| 50 | +- Naming patterns (camelCase, snake_case, etc.) |
| 51 | +- Formatting and linting tools used |
| 52 | +- Any style guides followed |
| 53 | + |
| 54 | +**Testing Guidelines** |
| 55 | +- Testing framework(s) used |
| 56 | +- How to run specific tests |
| 57 | +- Test naming conventions |
| 58 | +- Coverage requirements (if any) |
| 59 | + |
| 60 | +**Commit & Pull Request Guidelines** |
| 61 | +- Commit message format (look at git log for patterns) |
| 62 | +- PR requirements (descriptions, linked issues, etc.) |
| 63 | + |
| 64 | +Add other sections if relevant to this specific project, such as: |
| 65 | +- Security considerations |
| 66 | +- Architecture overview |
| 67 | +- Environment setup |
| 68 | +- Deployment process |
| 69 | + |
| 70 | +## Important |
| 71 | + |
| 72 | +- Never overwrite an existing AGENTS.md file |
| 73 | +- If AGENTS.md already exists, inform the user and offer to review or update it instead |
| 74 | +- Focus on information that helps AI agents work effectively in this codebase |
| 75 | +- Omit sections that don't apply to this project |
0 commit comments