[codex] Add devkit scaffold#1
Merged
Merged
Conversation
ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Free Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a full reference repository template: governance and decision documents, CI/security workflows, editor/packaging configs, local dev orchestration and deterministic worktree ports, example Python FastAPI and TypeScript web apps with migrations and tests, alternates, scripts, and agent-facing skills and docs. ChangesReference repository scaffold
Estimated code review effort:
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6646e0686e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
Adds the initial 508 Devkit repository scaffold: a Bun/TypeScript + uv/Python workspace, local dev scripts (including deterministic worktree ports), Compose-based infra, CI/security workflows, and baseline docs/skills intended to be copied/adapted into target repos.
Changes:
- Introduces deterministic per-worktree port allocation (
scripts/worktree-ports.py) plus dev/compose wrappers that consume it. - Adds Python (
uvworkspace, Ruff/MyPy/Pytest) and TypeScript (Bun workspaces, Biome, Vitest, Drizzle) scaffolding with lockfiles and basic example code. - Adds documentation, skills, GitHub templates/workflows, and supply-chain/dependency cooldown policies.
Reviewed changes
Copilot reviewed 101 out of 104 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_worktree_ports.py | Unit tests for worktree port helper script |
| skills/triage-ci-failure/SKILL.md | Agent skill: CI failure triage workflow |
| skills/promote-context/SKILL.md | Agent skill: promote .context/ learnings |
| skills/add-service/SKILL.md | Agent skill: add new service workflow |
| skills/add-migration/SKILL.md | Agent skill: add DB migration workflow |
| skills/508-devkit/SKILL.md | Agent skill: apply/normalize devkit in a target repo |
| SECURITY.md | Security policy + dependency policy notes |
| scripts/worktree-ports.py | Deterministic port allocation + env/exec helper |
| scripts/typecheck.sh | Root typecheck wrapper (Python + web) |
| scripts/test.sh | Root test wrapper (Python + web) |
| scripts/lint.sh | Root lint wrapper (Python + web) |
| scripts/format.sh | Root format wrapper (Python + web) |
| scripts/docker-compose.sh | Compose wrapper that injects worktree ports |
| scripts/dev.sh | Host-run dev orchestration + Compose infra boot |
| scripts/check-all.sh | Aggregated lint/format/type/test/build checks |
| renovate.json | Renovate defaults + release-age cooldown |
| README.md | Devkit overview, quickstart, repo layout, policies |
| pyproject.toml | Root Python workspace config for uv/ruff/mypy/pytest |
| pnpm-workspace.example.yaml | pnpm fallback workspace example |
| packages/shared/src/example_shared/settings.py | Shared Pydantic settings model |
| packages/shared/src/example_shared/schemas.py | Shared Pydantic response schema(s) |
| packages/shared/src/example_shared/observability.py | Minimal logging config + summary helper |
| packages/shared/src/example_shared/init.py | Shared package marker |
| packages/shared/pyproject.toml | Shared package metadata/deps |
| package.json | Root Bun workspace + scripts |
| llms.txt | Repo index for LLM/agent entrypoints |
| LICENSE | MIT license text |
| docs/template-proposal.md | Template rationale and default shape |
| docs/supply-chain.md | Cooldowns + frozen installs policy |
| docs/secrets.md | Secrets handling + optional SOPS guidance |
| docs/pattern-report.md | Report of observed repo conventions (source inputs) |
| docs/observability.md | Observability/env naming policy |
| docs/interfaces.md | Template-vs-skill interface guidance |
| docs/github-workflows.md | GitHub templates/workflow guidance |
| docs/frontend.md | Framework-neutral frontend policy |
| docs/development.md | Local dev workflow documentation |
| docs/deployment.md | Deployment decision record template |
| docs/agent-walkthrough.md | Example agent flow when applying devkit |
| docker-compose.yml | Compatibility wrapper including compose.yml |
| DECISIONS.md | Devkit “constitution” / decision authority |
| CONTRIBUTING.md | Contribution principles + local checks |
| compose.yml | Local infra services (Postgres/Redis/MinIO profile) |
| CLAUDE.md | Claude pointer to AGENTS.md |
| bunfig.toml | Bun install policy (cooldown + isolated linker) |
| bun.lock | Bun lockfile |
| biome.json | Biome formatter/linter configuration |
| apps/web/vitest.config.ts | Vitest config for web workspace |
| apps/web/tsconfig.json | TypeScript compiler configuration |
| apps/web/tests/index.test.ts | Example Vitest unit test |
| apps/web/src/index.ts | Minimal TS helper example (apiBaseUrl) |
| apps/web/src/db/schema.ts | Drizzle schema placeholder |
| apps/web/package.json | Web workspace scripts/deps |
| apps/web/drizzle.config.ts | Drizzle-kit config |
| apps/api/tests/test_postgres_integration.py | Example integration test (gated by env var) |
| apps/api/tests/test_health.py | FastAPI health endpoint test |
| apps/api/src/example_api/main.py | FastAPI app factory + entrypoint |
| apps/api/src/example_api/db.py | SQLAlchemy base/metadata |
| apps/api/src/example_api/init.py | API package marker |
| apps/api/pyproject.toml | API package metadata/deps + console script |
| apps/api/migrations/script.py.mako | Alembic migration template |
| apps/api/migrations/env.py | Alembic env (settings-driven URL) |
| apps/api/alembic.ini | Alembic config |
| alternates/todo-to-issue/todo-to-issue.yml.example | Opt-in TODO-to-issue workflow example |
| alternates/todo-to-issue/README.md | Opt-in TODO-to-issue documentation |
| alternates/pnpm/README.md | pnpm alternate documentation |
| alternates/pnpm/pnpm-workspace.yaml | pnpm workspace config (alternate) |
| alternates/pnpm/package.json | pnpm-based root package.json (alternate) |
| alternates/pnpm/ci-web-job.yml | CI web job fragment for pnpm alternate |
| alternates/github/README.md | GitHub alternates overview |
| alternates/github/community/DISCUSSION_TEMPLATE/questions.yml | Opt-in discussions template |
| alternates/github/CODEOWNERS.example | Opt-in CODEOWNERS template |
| alternates/dockerfiles/README.md | Deployment Dockerfile alternates overview |
| alternates/dockerfiles/Dockerfile.worker.example | Example worker Dockerfile |
| alternates/dockerfiles/Dockerfile.web-typescript.example | Example TS check/build Dockerfile |
| alternates/dockerfiles/Dockerfile.api.example | Example API Dockerfile |
| alternates/devcontainer/README.md | Devcontainer opt-in documentation |
| alternates/devcontainer/devcontainer.json.example | Example devcontainer config |
| alternates/dev-scripts/worktree-ports.mjs | JS-only alternate for worktree ports |
| alternates/dev-scripts/README.md | Dev-script alternates overview |
| alternates/dev-scripts/dev.ts | TS dev runner alternate |
| AGENTS.md | Canonical agent operating instructions |
| .worktreeinclude | Allowlist of files to copy into sibling worktrees |
| .sops.yaml.example | Optional SOPS rules template |
| .pre-commit-config.yaml | Pre-commit hooks (ruff + local wrappers) |
| .gitignore | Ignore local env/venv/cache/build outputs + .context artifacts |
| .github/workflows/security.yml | Secret scanning + dependency review workflow |
| .github/workflows/ci.yml | CI with path filtering + python/web/compose jobs |
| .github/PULL_REQUEST_TEMPLATE.md | PR template |
| .github/ISSUE_TEMPLATE/feature_request.yml | Feature request issue form |
| .github/ISSUE_TEMPLATE/docs_request.yml | Docs request issue form |
| .github/ISSUE_TEMPLATE/config.yml | GitHub issue template config |
| .github/ISSUE_TEMPLATE/bug_report.yml | Bug report issue form |
| .env.example | Environment contract template |
| .editorconfig | Formatting defaults |
| .dockerignore | Docker build context exclusions (secrets/state/deps) |
| .cursor/rules/repo-conventions.mdc | Cursor rules pointing to AGENTS.md |
| .context/summaries/README.md | .context summaries guidance |
| .context/summaries/.gitkeep | Keep empty summaries dir committed |
| .context/runbooks/local-dev.md | Local dev runbook |
| .context/failures/README.md | .context failures guidance |
| .context/failures/.gitkeep | Keep empty failures dir committed |
| .context/decisions/tooling.md | .context tooling decision record |
| .context/architecture/repository-layout.md | .context repo layout note |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1bb611eeb5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
uv.lock/bun.locklockfiles..worktreeincludeand.dockerignoretemplates with examples and guidance for local worktrees and Docker build contexts.Validation
./scripts/lint.sh./scripts/typecheck.sh./scripts/test.sh./scripts/check-all.shSummary by CodeRabbit
New Features
Documentation
Configuration
Tests