Skip to content

AGENTS.md

Latest commit

 

History

History
57 lines (36 loc) · 2.5 KB

AGENTS.md

File metadata and controls

57 lines (36 loc) · 2.5 KB
Raw

Agent Instructions

This file provides context for AI coding assistants working in the Babylon repository.

Project overview

Babylon is Red Hat GPTE's self-service platform for catalog items, workshops, and lab environments on OpenShift. The main user-facing stack lives under catalog/ (React UI + aiohttp API). Operators, Helm charts, and deployment docs cover the rest of the platform.

Development skills

Follow these skills when working on catalog components:

AI layout in this repo

Path Purpose
AGENTS.md Entry point for any coding agent
.agents/skills/ Project skills (tool-agnostic; Cursor, Claude Code, and others load this)

Do not duplicate skills under .cursor/skills/ — Cursor discovers .agents/skills/ directly. Invoke /autocommit for grouped conventional commits.

PatternFly AI helpers (install locally)

For catalog/ui work, install patternfly/ai-helpers from upstream (not vendored in this repo). Prioritize the react and migration plugins.

Cursor: add the patternfly/ai-helpers plugin marketplace in Cursor settings, then enable the plugins you need.

Claude Code:

/plugin marketplace add patternfly/ai-helpers
/plugin install react@ai-helpers

Optional: PatternFly MCP server for component docs in the editor.

Local development quick start

  1. oc login to a cluster with Babylon deployed
  2. Start the catalog API from catalog/api/ (port 8080)
  3. Start the catalog UI from catalog/ui/ with pnpm run start:dev (port 9000, proxies to API)

Conventions

  • Match existing code style and patterns in each component
  • UI: PatternFly 6, SWR, @app/* path alias, routes in src/app/routes.tsx
  • API: aiohttp routes in app.py, env vars for local dev (ENVIRONMENT=development, BABYLON_NAMESPACE)
  • Do not commit secrets, .env files, or local tool caches (e.g. .pnpm-store/)

Further reading