Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.79 KB

File metadata and controls

37 lines (26 loc) · 2.79 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 repository hosts Hoverkraft's marketing site, built with Astro 5 and Tailwind CSS inside the application/ directory. Environment requirements, setup commands, and the development workflow live in the Project readme.

Primary documentation touchpoints

Repository-specific guidelines (required)

  • Ensure all code changes maintain compatibility with the Astro framework and Tailwind design system already configured in application/.
  • Integrate features with the existing i18n utilities so default (fr) and secondary (en) locales stay consistent.
  • Preserve blog frontmatter structure and permalink patterns when updating content in application/src/content/ or application/src/data/.
  • Run npm run lint and npm run build from application/ (or make lint/make build) before finalizing changes.
  • Avoid hardcoding configuration values; update application/src/config.yaml for metadata, analytics IDs, and feature toggles.
  • Store optimized assets in application/src/assets/images and import them via the shared Image component for metadata handling.
  • Align new components and utilities with the shared TypeScript types in application/src/types.d.ts.
  • Pull analytics configuration from application/src/config.yaml; do not inline vendor IDs.
  • Use the Partytown setup in application/astro.config.ts for third-party scripts when possible.

Agent-specific development patterns

  • Default to the Make targets documented in the readme to mirror CI behavior.
  • Focus code edits inside application/ unless explicitly coordinating infrastructure changes.
  • Prefer referencing readme sections instead of recreating documentation in pull requests.