playbooks

home / skills / plurigrid / asi / init

init skill

/skills/init

This skill initializes a repository by generating an AGENTS.md contributor guide with clear sections and actionable instructions.

npx playbooks add skill plurigrid/asi --skill init

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
1.8 KB
---
name: init
version: 1.0.0
description: Initialize a new repository with AGENTS.md
disable-model-invocation: true
---

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.

Overview

This skill creates a concise AGENTS.md titled "Repository Guidelines" to initialize a new repository for the "everything is topological chemputer!" project. It generates a focused contributor guide with sections for project structure, build/test commands, coding style, testing, and pull request practices. The output is formatted in Markdown and tailored to this repository's HTML primary language and typical web project layout.

How this skill works

The skill inspects repository metadata (name, description, primary language) and produces a 200–400 word Markdown file that follows the requested outline. It includes concrete examples such as directory paths and commands, and adapts sections to be relevant to an HTML-centered project. The generated file is concise, instructional, and ready to commit as AGENTS.md.

When to use it

  • Initializing a new repository to provide contributors with a clear onboarding guide.
  • Standardizing contribution expectations before the first pull request is merged.
  • Bootstrapping documentation for a web-focused project that primarily uses HTML and related tooling.
  • Creating a minimal contributor guide for repositories without existing contributor docs.

Best practices

  • Keep the document under 400 words; be direct and actionable.
  • Include concrete examples (commands, paths, naming patterns) for clarity.
  • Use Markdown headings for quick navigation and short paragraphs for readability.
  • Tailor build/test commands to the repository's actual tooling before committing.

Example use cases

  • Generate AGENTS.md during repository creation to provide immediate contributor guidance.
  • Update AGENTS.md when adding new build tooling (e.g., switching from Make to npm scripts).
  • Provide a compact onboarding file for external contributors or code reviewers.
  • Ensure consistent commit and PR practices across small web projects.

FAQ

What title will the file use?

The file is titled "Repository Guidelines" as requested.

How long is the generated document?

The generated AGENTS.md is concise, targeting 200–400 words to remain practical and readable.

Does the skill invent commands?

It suggests common commands (e.g., npm test, npm run build, make dev) but recommends verifying and adjusting them to match the repository's actual tooling.