Contributing

August 7, 2026 · View on GitHub

简体中文 | English

The detailed contribution guide lives in the language-specific docs:

Quick checklist:

  • Start at codexpet.top: open the workflow in local Codex or copy its prompt, then request community production or create and submit your own pet without a full clone
  • Use a [Request] issue when the pet does not exist yet; use a [Submission] issue only with the submitter's approval when one actionable blocker remains after recovery and retry
  • Appearance-specific requests must include a maintainer-viewable image attachment, public image URL, or official character/source page; private-chat images, local paths, and prose descriptions are not attachments
  • Advanced contributors may open a focused pull request through GitHub, Codespaces, or a sparse clone
  • Completed submissions should be opened as ready-for-review pull requests; drafts are only for knowingly unfinished work and must list what remains
  • Use pets/<pet-slug>--<author-slug>/
  • Submit only submission.json, pet.json, and spritesheet.webp
  • Keep pet.json id equal to the folder name
  • For v1, omit spriteVersionNumber or set it to 1, and use a 1536x1872 spritesheet
  • For v2, set spriteVersionNumber: 2, and use a 1536x2288 spritesheet with 16 look directions
  • Fill in submission.json
  • Give new submissions a stable canonical_key; different authors may publish independent versions of the same character under the same key, but each later version needs a clear variant_note and a non-identical spritesheet
  • State either a formal asset license or an explicit non-commercial-only usage restriction; a formal license name is optional
  • Do not place previews, QA files, references, or README files inside the pet folder
  • Contributors should run npm run validate:pr and npm run lint
  • After submission, maintainers visually review character direction, action quality and continuity, plus green, purple, cyan, magenta, or other transparent-edge residue; they may optimize the spritesheet or metadata before merge
  • README, pets.json, install-manifest.json, and preview assets are generated by maintainers/CI after merge
  • Maintainers should run npm run previews, npm run readmes, npm run validate, and npm run lint before publishing generated assets

AI contributors should follow .agents/skills/submit-codex-pet. Codex or another prompt-compatible AI assistant can start from references or existing pet files; the completed pet should normally become a focused pull request through the GitHub API, without downloading the existing pet catalog.