Prompts · RulesEveryday codingWeb & UIReviewed

AGENTS.md

Guidance for agents working on this Next.js site: use npm run dev, not npm run build, during agent sessions; keep lockfiles in sync; prefer TypeScript.

View on GitHub

Kind: Rules
Works with: Codex, Cursor, GitHub Copilot, Gemini / Antigravity, Windsurf / Devin, Any agent
Languages: TypeScript / JavaScript
Source: AGENTS.md @ d001185d792e
Path: AGENTS.md
License: MIT
Jobs: Guardrails, Context management

InstallCopy it from the source repository, or sign in and let the assistant adapt it for your project.

# AGENTS Guidelines for This Repository

This repository contains a Next.js application located in the root of this repository. When
working on the project interactively with an agent (e.g. the Codex CLI) please follow
the guidelines below so that the development experience – in particular Hot Module
Replacement (HMR) – continues to work smoothly.

## 1. Use the Development Server, **not** `npm run build`

* **Always use `npm run dev` (or `pnpm dev`, `yarn dev`, etc.)** while iterating on the
  application.  This starts Next.js in development mode with hot-reload enabled.
* **Do _not_ run `npm run build` inside the agent session.**  Running the production
  build command switches the `.next` folder to production assets which disables hot
  reload and can leave the development server in an inconsistent state.  If a
  production build is required, do it outside of the interactive agent workflow.

## 2. Keep Dependencies in Sync

If you add or update dependencies remember to:

1. Update the appropriate lockfile (`package-lock.json`, `pnpm-lock.yaml`, `yarn.lock`).
2. Re-start the development server so that Next.js picks up the changes.

## 3. Coding Conventions
…