Skip to content

AGENTS.md

Latest commit

 

History

History
32 lines (21 loc) · 1.74 KB

AGENTS.md

File metadata and controls

32 lines (21 loc) · 1.74 KB

AGENTS.md — agent instructions and operational contract

This file is written for automated coding agents (for example: Copilot coding agents). It exists to provide a concise operational contract and guardrails for agents working in this repository. It is not the canonical source for design or style rules. Those live in the developer documentation linked below.

Organization-wide guidelines (required)

Quick Start

This project is a collection of opinionated GitHub Actions and reusable workflows that provide common continuous-integration building blocks.

Key sections to reference

  • Overview – Project purpose, supported scenarios, and scope
  • Actions – Catalog of available actions grouped by usage
  • Reusable Workflows – Ready-to-consume workflows for frequent CI automation needs
  • Contributing – Structure patterns, development standards, and review expectations
  • Development Workflow – Commands for linting, testing, and local verification

Agent-specific development patterns

Critical workflow knowledge

# Essential commands for development
make lint        # Run Super Linter (dockerized)
make lint-fix    # Auto-fix linting issues where possible
gh act -W .github/workflows/workflow-file-to-test.yml  # Test workflows locally with `act`

For detailed documentation on each action and workflow, refer to the individual readme files linked in the main README.md.