Files
codex-agent-repository-kit/AGENTS.md
2026-05-15 04:42:55 +02:00

2.6 KiB

Agent Instructions For This Repository

This file is for Codex agents working on the Codex Agent Repository Kit itself. The public README.md is for humans and should stay focused on setup and usage.

Start Of Task

  • Check git status --short.
  • If the working tree is clean, run git pull --ff-only before editing.
  • If local changes exist, preserve them and do not overwrite user work.
  • Conserve context tokens: use rg, targeted file reads, and short summaries instead of loading unrelated files or long logs.

Repository Purpose

This repository ships reusable baseline files for other repositories:

  • files/ contains templates copied into target repositories.
  • agent-quickstart.md, new-repository.md, and existing-project.md are agent workflows.
  • manifest.json is the source of truth for copy targets and placeholders.
  • profiles/ contains stack-specific guidance.

Editing Rules

  • Keep repository owner, repository name, project names, and local paths dynamic. This kit intentionally targets https://git.wilkensxl.de and SSH port 2222, so keep that host/port consistent in user-facing setup and Gitea workflow defaults.
  • If a new placeholder is introduced, update manifest.json, the README placeholder list, and placeholder scans in workflow templates.
  • Keep README.md user-facing. Put agent operating rules in this file or the workflow docs.
  • Keep files/AGENTS.md generic; it is copied into target repositories and must not describe this repository specifically.
  • Do not include secrets, tokens, private data, or sensitive logs in docs, issues, commits, or release notes.

Follow-up Work

  • Create focused tracker issues for real follow-up work that is outside the current scope or can be done independently.
  • Do not create issues for work that can be safely completed in the current task.
  • If issue creation is unavailable, update docs/agent-handoff.md with the blocker and next steps.

Verification

Before committing:

Get-Content manifest.json | ConvertFrom-Json | Out-Null
Get-Content manifest.schema.json | ConvertFrom-Json | Out-Null
Get-Content files\blueprint.json | ConvertFrom-Json | Out-Null
git diff --check

Also verify:

  • every manifest.json copyMap source exists,
  • every profile path exists,
  • reusable files contain no private instance defaults such as a specific username or private host,
  • README.md documents every placeholder listed in manifest.json.

Release

  • Bump manifest.json version.
  • Update CHANGELOG.md.
  • Commit changes.
  • Create an annotated tag such as v1.0.2.
  • Push main and tags.
  • Create or update the Gitea release when a valid API token is available.