Skip to content

AGENTS.md

Latest commit

 

History

History
32 lines (21 loc) · 1.72 KB

AGENTS.md

File metadata and controls

32 lines (21 loc) · 1.72 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 for streamlined CI/CD workflows. For comprehensive documentation, see the main README.md.

Key Sections to Reference

  • Overview - Project purpose and scope
  • Actions - Complete catalog of available actions by category
  • Reusable Workflows - Orchestration workflows for complex deployments
  • Contributing - Guidelines for contributing to the project; Structure patterns and development standards
  • Development Workflow - Commands for linting, testing, and local development

Agent-Specific Development Patterns

Critical Workflow Knowledge

# Essential commands for development
make lint        # Run Super Linter (dockerized)
make lint-fix    # Auto-fix linting issues
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.