Files
MrTrust/files/project.md
2026-05-15 21:18:19 +00:00

1.4 KiB

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. verify release artifacts exclude Codex kit metadata such as AGENTS.md, .codex/, blueprint.md, blueprint.json, template workflows, and agent handoff notes unless the user explicitly wants those shipped,
  6. create a tag,
  7. create the release.

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