agents-writer
npx machina-cli add skill narumiruna/agent-skills/agents-writer --openclawAGENTS.md Contributor Guide
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
Build, Test, and Development Commands
- 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.
Source
git clone https://github.com/narumiruna/agent-skills/blob/main/skills/agents-writer/SKILL.mdView on GitHub Overview
The AGENTS.md Contributor Guide provides clear, actionable guidelines for contributing to the repository. It generates a concise, well-structured document at the repository root with sections on Build, Test, and Development Commands; Testing Guidelines; and Commit & Pull Request Guidelines. This helps new and returning contributors follow consistent practices when adding features or updating contributor documentation.
How This Skill Works
The tool assembles a Markdown document named AGENTS.md at the repository root using the outlined sections from the skill. It enforces a concise 200-400 word target, uses Markdown headings, practical examples, and project-specific commands. If certain sections are not relevant, they can be omitted while keeping essential sections intact.
When to Use It
- When starting a new repository and onboarding contributors
- When updating governance after changes to build or testing tooling
- When adding new modules or components that affect contribution guidelines
- Before submitting a PR that updates contributor docs
- During a documentation audit to ensure AGENTS.md aligns with current practices
Quick Start
- Step 1: Create or open AGENTS.md at the repository root
- Step 2: Populate sections following the prescribed outline and tailor commands to the project
- Step 3: Validate formatting, run linters, and submit as part of a PR
Best Practices
- Follow the 200–400 word length guideline and keep sections concise
- Use precise, project-specific commands and paths
- Maintain a professional, instructional tone and avoid assumptions
- Include practical examples (commands, paths, naming patterns)
- Keep content aligned with the repository's current tooling and policies; omit irrelevant sections
Example Use Cases
- AGENTS.md including a Build, Test, and Development Commands section with indentation rules and a linting tool reference
- Example commands such as 'npm run build', 'npm test', and 'npm run lint' aligned to the project
- Directory paths like ./docs, ./src, and ./tests used in examples
- Commit & PR Guidelines illustrating a message format (e.g., feat: add contributor guidelines) and required PR details
- Optional Architecture Overview or Security & Configuration Tips sections when relevant
