AGENTS.md · git:20261117.bf3327d · 2026-11-17 · sha256 83bc30b48fcf79d2
AGENTS.md git:20261117.bf3327dA
Immutable. This exact content never changes and is served at /api/v1/blob/83bc30b48fcf79d2.
# AGENTS.md ## Project overview This repository is a template for AI-enabled software projects. It demonstrates how to organize: - shared agent instructions in `AGENTS.md` - Claude-specific instructions in `CLAUDE.md` - Claude internal agents and skills in `.claude/` - GitHub Copilot instructions, agents, and skills in `.github/` - external/shared user-facing skills in `skills/` ## Working rules - Read `README.md` first for the repository purpose. - Read `LEARN.md` for the guided explanation of the repository structure and how the layers fit together. - Read `CLAUDE.md` for Claude-specific project rules. - Read `AGENTS.md` for agents project rules. - Check `.github/copilot-instructions.md` for Copilot-specific guidance. - Prefer small, focused changes. - Do not make unrelated refactors. - Update docs when behavior or structure changes. ## Commands This repo is currently a documentation-first template repo. - Install: no install step is required yet - Dev: no local app/dev server is configured yet - Test: `bash .claude/skills/validate-learning-repo/scripts/check-required-files.sh` - Lint: no dedicated lint command is configured yet ## Project structure - `.claude/` contains internal Claude configuration for maintainers. - `.github/` contains internal GitHub/Copilot configuration for maintainers. - `skills/` contains external/shared skills for users and outside agents. ## Code and docs conventions - Keep examples short and practical. - Prefer clear folder names and predictable file names. - When adding a skill, use this structure. Only `SKILL.md` is required; add `scripts/`, `references/`, and `assets/` when needed: ``` <skill-name>/ ├── SKILL.md ├── scripts/ ├── references/ └── assets/ ``` - Keep instructions easy to scan. - Use Markdown for guidance files. ## Testing and validation Before finishing work: - run `bash .claude/skills/validate-learning-repo/scripts/check-required-files.sh` - check that links and referenced files still exist - make sure any new folder follows the documented template structure - make sure examples and file references still match the real repo - if hook-related files changed, check: - `bash scripts/hooks/claude-session-context.sh` - `bash scripts/hooks/github-session-start-check.sh` ## Pull request guidance - Explain what changed and why. - Mention whether the change affects Claude, Copilot, or external skills. - Include doc updates when repo structure changes. ## Boundaries - Do not edit secrets, tokens, or environment files. - Do not invent tools or folders that are not present in the repo. - Do not remove existing AI conventions without updating the documentation. - Ask for clarification only when a missing decision blocks safe progress.