Skip to content

AGENTS.md

Latest commit

 

History

History
66 lines (46 loc) · 2.5 KB

AGENTS.md

File metadata and controls

66 lines (46 loc) · 2.5 KB
Raw

Agent & Contributor Conventions

This file documents conventions for both human contributors and AI agents working in this repository.

Commit Style

Use Conventional Commits:

<type>(<scope>): <short description>

Common types: feat, fix, chore, docs, ci, refactor

Examples:

  • feat(scaffold): add teardown sub-skill
  • fix(gitlab): correct OIDC subject format
  • ci: update yamllint pre-commit hook

Skill Development Standards

  • Frontmatter: name and description fields only
  • Keep each SKILL.md under 500 lines; move long reference content to references/
  • Use ⚠️ MANDATORY only for truly required stops — never ALWAYS or NEVER
  • All user interactions must go through ask_user_question
  • Collect all required inputs at Stopping Points before any action that creates resources
  • Use enter_plan_mode + exit_plan_mode around each beat's confirmation (single confirm, not multiple raw asks)
  • Skip plan mode when a beat contains only a single command or a read-only/status check — the ceremony adds no value. Use plan mode when: multiple steps run together, the action is destructive/irreversible, or the user needs to review values before proceeding.
  • Three-point beat structure: "What I'll do" → execute → "What we did"

.agentignore

Template repos ship a .agentignore file at the repository root. The scan agent reads this before scanning and skips any files or directories matching the patterns.

Syntax follows .gitignore rules:

  • Lines starting with # are comments
  • Blank lines are ignored
  • Glob patterns (*.pyc, __pycache__/, vendor/)
  • Prefix / to anchor to repo root; prefix ! to un-ignore

Default exclusions: Python artifacts (__pycache__/, *.pyc), virtual environments (.venv/), build outputs (dist/, build/), vendored deps (node_modules/).

The fix agent does not read .agentignore — if a bug was found in a file, the fix should proceed regardless of scan exclusion rules.

Repo References

Always use full HTTPS URLs — never org/repo shorthand:

Resource URL
This plugin https://github.com/Snowflake-Labs/devops-snowflake-coco-agents
GitHub template https://github.com/Snowflake-Labs/github-coco-agent
GitLab template https://gitlab.com/snowflake-dev/gitlab-coco-agent

Plugin Names

  • GitHub repo name (marketplace discoverability): devops-snowflake-coco-agents
  • Plugin name field (post-install): devops-coco-agents