codex-agent-repository-kit/files/project.md

Codex Project Notes

Project

PROJECT_NAME is PROJECT_DESCRIPTION

Repository:

REPOSITORY_OWNER/REPOSITORY_NAME

Commands

Use these commands as the source of truth:

LINT_COMMAND
TEST_COMMAND
BUILD_COMMAND
AUDIT_COMMAND
README_COMMAND

If a command does not exist, document the closest safe alternative. Do not invent commands that cannot run.

Stack

PROJECT_STACK

Package manager or build tool:

PACKAGE_MANAGER

Build Artifacts

Release artifacts are produced in:

ARTIFACT_OUTPUT_DIRECTORY

Expected files:

ARTIFACT_NAME

Security Rules

• Do not commit secrets, tokens, .env files, certificates, or private keys.
• Treat generated credentials as sensitive.
• Prefer local generation and local processing for user data.
• Keep dependency audit results visible in CI where possible.
• Do not add external network calls unless the feature explicitly requires them.

Release Rules

Before a release:

1. run the release checklist,
2. verify CI is green,
3. verify download links,
4. update README and changelog,
5. create a tag,
6. create the release.

Do not create releases unless the user explicitly asks for a release.