From 6807660ddba98367addfdfa05945662cd31d091c Mon Sep 17 00:00:00 2001 From: ToxicCrzay270 <185776014+ToxicCrzay270@users.noreply.github.com> Date: Fri, 15 May 2026 00:42:11 +0200 Subject: [PATCH] Add Codex repository baseline --- .codex/project.md | 76 +++++++++++++++++++++++++++++++++++++++ .gitignore | 48 +++++++++++++++++++++++++ AGENTS.md | 51 ++++++++++++++++++++++++++ CHANGELOG.md | 7 ++++ CONTRIBUTING.md | 41 +++++++++++++++++++++ README.md | 60 +++++++++++++++++++++++++++++++ SECURITY.md | 21 +++++++++++ docs/agent-handoff.md | 40 +++++++++++++++++++++ docs/release-checklist.md | 35 ++++++++++++++++++ docs/release-notes.md | 28 +++++++++++++++ docs/security-review.md | 54 ++++++++++++++++++++++++++++ 11 files changed, 461 insertions(+) create mode 100644 .codex/project.md create mode 100644 .gitignore create mode 100644 AGENTS.md create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 docs/agent-handoff.md create mode 100644 docs/release-checklist.md create mode 100644 docs/release-notes.md create mode 100644 docs/security-review.md diff --git a/.codex/project.md b/.codex/project.md new file mode 100644 index 0000000..2c22bc5 --- /dev/null +++ b/.codex/project.md @@ -0,0 +1,76 @@ +# Codex Project Notes + +## Project + +`Robocopy_Overhaul` is a Codex-ready repository baseline for a Robocopy overhaul project. + +Repository: + +```text +Toxic/Robocopy_Overhaul +``` + +Remote: + +```text +https://git.wilkensxl.de/Toxic/Robocopy_Overhaul.git +``` + +## Commands + +No stack-specific commands are defined yet. + +Use this section as the source of truth once the project has implementation code: + +```text +lint: PENDING +test: PENDING +build: PENDING +audit: PENDING +readme: manual README +``` + +Do not invent commands that cannot run. + +## Stack + +```text +PENDING +``` + +Package manager or build tool: + +```text +PENDING +``` + +## Build Artifacts + +Release artifacts are not defined yet. + +Expected files: + +```text +PENDING +``` + +## 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 after a stack is chosen. +- 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. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..39784f6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,48 @@ +# Dependencies +node_modules/ +vendor/ +.venv/ +venv/ +__pycache__/ + +# Build outputs +dist/ +build/ +out/ +release/ +target/ +bin/ +obj/ + +# Logs and temporary files +*.log +*.tmp +*.temp +.cache/ +.turbo/ +.vite/ +.pytest_cache/ + +# Local environment and secrets +.env +.env.* +!.env.example +*.pem +*.key +*.pfx +*.p12 +*.crt +*.cer +*.token +secrets/ + +# OS and editor files +.DS_Store +Thumbs.db +.idea/ +.vscode/ +*.swp +*.swo + +# Local template source +codex-agent-repository-kit/ diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..79b2c1a --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,51 @@ +# Agent Instructions + +## Project + +Robocopy_Overhaul: Codex-ready repository baseline for a Robocopy overhaul project. + +## Repository Rules + +- Start by reading `AGENTS.md` and `.codex/project.md`. +- Keep changes scoped to the user's request. +- Prefer existing project patterns once application code exists. +- Do not commit secrets, `.env` files, private keys, certificates, or tokens. +- Do not rewrite history or run destructive git commands unless explicitly requested. +- Do not create a release unless explicitly requested. +- Check the working tree before editing and before finishing. Preserve unrelated user changes. +- If `GITEA_TOKEN` is available locally, use it only for read-only Gitea API checks such as private repository metadata, package-read visibility, and Actions run status. Never print, commit, or store the token. +- Repository cleanup automation must be non-destructive if added later. +- Dependency, compliance, and release dry-run automation must report findings only unless the user explicitly asks for write actions. + +## Commands + +No stack-specific commands are defined yet. + +When code is added, update this file and `.codex/project.md` with the real commands for: + +```text +lint +test +build +audit +``` + +## Artifacts + +No release artifact output directory is defined yet. + +## Security Notes + +- Review `docs/security-review.md` before release work. +- Treat generated credentials and config files as sensitive. +- Keep external network calls documented. +- Prefer local processing for user data. +- Keep CI publishing secrets in repository or organization secrets, not in tracked files. +- Ensure `.gitignore` covers local config, build outputs, logs, temporary files, and secret material for the detected stack. + +## Finish Checklist + +- `git diff --check` passes when the directory is a Git repository. +- The cheapest reliable verification command has been run, or the reason it could not run is documented. +- README, changelog, security review, and release checklist are updated when the change touches release behavior. +- `docs/agent-handoff.md` is updated when work is interrupted, risky, or spans multiple sessions. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4ed52d3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to this project are documented here. + +## Unreleased + +- Added Codex Agent Repository Kit baseline files. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9b27e80 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +## Working Rules + +- Keep changes scoped to the issue or user request. +- Prefer existing project patterns once application code exists. +- Do not commit secrets, generated credentials, local `.env` files, or private keys. +- Do not create releases unless explicitly requested. +- Preserve unrelated user changes. + +## Before Committing + +Run the cheapest reliable verification commands for this project. No stack-specific commands are defined yet. + +When the directory is a Git repository, also run: + +```bash +git diff --check +``` + +If a command cannot run, document why in the final response or handoff notes. + +## Pull Requests + +Pull requests should include: + +- summary of changes, +- verification performed, +- known risks or skipped checks, +- artifact/download notes when relevant. + +## Releases + +Before release work, update: + +```text +CHANGELOG.md +docs/release-checklist.md +docs/security-review.md +README.md +``` diff --git a/README.md b/README.md new file mode 100644 index 0000000..8324f57 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Robocopy_Overhaul + +Codex-ready repository baseline for a Robocopy overhaul project. + +




