Imported from mcollina/skills (
AGENTS.md). Install upstream withnpx skills add mcollina/skills. Copyright stays with the author.
This file provides guidance to AI coding agents like Claude Code (claude.ai/code), Cursor AI, Codex, Gemini CLI, GitHub Copilot, and other AI coding assistants when working with code in this repository.
What this repository is
- This is a skills/prompt library for AI-assisted development (not a typical application service).
- Primary content lives under
skills/as Markdown skill definitions and rule documents. src/index.tsis minimal and only exportsversion; it is not where product logic lives.
High-level architecture
1) Skill packages (skills/<skill-name>/)
Each skill directory is a self-contained package of guidance:
SKILL.md: entrypoint for the skill (metadata, when-to-use, instructions, links)rules/*.md: detailed rule documents referenced fromSKILL.md
Current top-level skills include:
documentationfastifyinitlinting-neostandard-eslint9nodenodejs-coreoauthoctocatskill-optimizersnipgraphertypescript-magician
2) Minimal TypeScript package surface (src/)
src/index.tsexports package version only.- TypeScript config (
tsconfig.json) is strict andnoEmit; this repo uses TS checks, not a compile output pipeline.
3) Documentation-driven behavior
- Most “logic” is instruction text in Markdown.
- Internal cross-references in
SKILL.mdfiles (for examplerules/...) are part of the public skill structure and should stay valid.
Common commands
Run from repository root.
- Install deps:
npm install - Typecheck:
npm run typecheck - Lint:
npm run lint - Run tests:
npm test(alias fornode --test) - Run a single test file:
node --test path/to/file.test.ts - Run tests matching a name:
node --test --test-name-pattern "pattern"
Editing rules for this repo
-
Treat
skills/*/SKILL.mdas an index contract.- Every
rules/*.mdfile must be explicitly mentioned and linked from that skill’s mainSKILL.md. - If you add/rename/remove any
rules/*.md, update the corresponding links inSKILL.mdin the same change.
- Every
-
Preserve skill metadata/frontmatter format.
- Skill and rule docs use YAML frontmatter (
name,description,metadata.tags).
- Skill and rule docs use YAML frontmatter (
-
Keep naming consistent with existing directory structure.
- Add new guidance under an existing skill’s
rules/unless you are intentionally creating a new skill.
- Add new guidance under an existing skill’s
-
Validate changes with project scripts.
- At minimum run
npm run typecheckandnpm testafter substantial edits.
- At minimum run
Existing agent/tooling constraints found in repo
.claude/settings.local.jsonallowsnpx githuman:*commands for Claude-specific workflows..githuman/is intentionally gitignored project tooling state.