2.0 KiB
Codex Mandatory Project Instructions
This repository is the source code for the MiaoJing AI creation platform.
Before any Codex agent changes code, fixes bugs, reviews behavior, or answers implementation-location questions in this repository, it must first read:
CODEX_MIAOJING_MEMORY.mddocs/codex-miaojing/README.md- The specific index document linked from the memory file for the task area:
docs/codex-miaojing/feature-code-index.mddocs/codex-miaojing/bug-location-guide.mddocs/codex-miaojing/api-reference.mddocs/codex-miaojing/architecture.md
Do not start by broad-searching the repository when the memory and index documents already identify a likely file path. Use those documents as the first routing layer, then verify against the current source before editing.
Every code adjustment, configuration change, workflow change, API change, UI change, and bug fix must include a documentation check before commit. If the change affects how future agents should locate code, diagnose bugs, call APIs, understand architecture, deploy, or verify behavior, update the matching document in docs/codex-miaojing/ and, if needed, update CODEX_MIAOJING_MEMORY.md in the same commit. Do not leave documentation updates for a later session.
All new development must remain compatible with the production admin upgrade path. Before finishing a change, decide whether it can be delivered as a hot update package or requires a cold update package through the admin console. Changes that touch src, server code, API routes, package.json, pnpm-lock.yaml, database schema, environment variables, PM2/runtime configuration, build scripts, backup/restore scripts, or generated server assets must be treated as cold-update candidates unless the upgrade runner explicitly supports them as safe hot-update payloads. Static/public asset-only changes may be hot-update candidates only after package preflight passes. Never finish deploy-facing work without considering backup, rollback, package preflight, and post-upgrade health checks.