peezy-tech/codex-toys
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
codex-toys/CONTRIBUTING.md
matamune 127735f90e
All checks were successful
trusted-ci / check (pull_request_target) Successful in 2m23s
Details
pr-policy / check (pull_request_target) Successful in 5s
Details
Simplify maintainer CI approval note
2026-05-20 22:47:42 +00:00

2 KiB
Raw Permalink Blame History

Contributing

Install dependencies from the repository root:

vp install

Run the checks that match the area you touched. For broad changes, use:

vp run check:types
vp run test
vp run release:check

Pull requests get a lightweight pr-policy check first. That check runs from trusted target-branch code with pull_request_target and does not check out or execute PR code. Full CI runs through the trusted-ci workflow after a maintainer applies the ci:run-full label; if a PR gets new commits, remove and reapply that label to approve another run for the new head. PRs that change .forgejo/workflows need the maintainer-applied ci:reviewed-workflow label before the policy check passes.

This is a Node 24 + pnpm + VitePlus monorepo. Keep changes scoped to the smallest package, app, flow, or docs surface that solves the problem:

  • packages/codex-client owns the public @peezy.tech/codex-flows package, app-server clients, generated protocol types, workspace helpers, and bundled bins.
  • packages/flow-runtime and packages/flow-backend-convex are compatibility and backend-library packages while the single-package platform migration continues.
  • apps/discord-bridge and apps/workspace-voice-gateway are gateway packages that depend on @peezy.tech/codex-flows.
  • apps/workspace-backend, apps/web, apps/cli, and apps/flow-runner are workspace-local apps that are also bundled into the core package where appropriate.
  • flows contains bundled flow packages used to maintain Codex bindings and Peezy fork releases.
  • docs/pages is the canonical user documentation.

Generated app-server protocol files live under packages/codex-client/src/app-server/generated. Do not hand-edit generated types unless you are deliberately repairing a generated update and will regenerate or document the follow-up.

Release and remote policy lives in RELEASE.md: jojo.build is canonical, Codeberg is a mirror, and GitHub is used for npm trusted publishing.