Skip to content

oneness1682-maker/codex-maintainer-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Codex Maintainer Kit

Turn issues, PR diffs, and git history into Codex-ready maintainer workflows.

codex-maintainer-kit is a small MIT-licensed CLI for open-source maintainers who want cleaner issue triage, PR review checklists, release-note drafts, and safe task briefs for Codex.

It does not replace maintainer judgment. It creates local heuristic drafts so humans and Codex can work from the same checklist. The MVP does not call AI APIs unless future optional integrations are enabled.

Why this exists

Open-source maintainers repeatedly do the same translation work:

  • rough issue report → reproducibility checklist and task scope
  • large PR diff → review risks and test checklist
  • git log → release notes and pre-tag checklist
  • maintainer request → Codex-ready task brief with guardrails

Codex is more useful when it receives concrete context, files to inspect, tests to run, and a definition of done. This kit generates that structure locally.

Install

python -m pip install git+https://github.com/oneness1682-maker/codex-maintainer-kit.git

For local development:

git clone https://github.com/oneness1682-maker/codex-maintainer-kit.git
cd codex-maintainer-kit
python -m pip install -e '.[dev]'

CLI

cmtk issue examples/issue-input.md
cmtk pr examples/pr-diff.patch
cmtk visual examples/visual-bug.md
cmtk release examples/release-log.txt
cmtk codex-task examples/issue-input.md --mode implementation

All commands also accept stdin:

git diff main...HEAD | cmtk pr -
printf '%s\n' 'Screenshot shows a clipped mobile widget' | cmtk visual -
git log --oneline v0.1.0..HEAD | cmtk release -

Commands

See also: docs/cli-spec.md.

cmtk issue

Classifies an issue as bug/docs/feature/question, estimates priority, and creates:

  • reproducibility checklist
  • Codex-ready task seed
  • maintainer reply draft

cmtk pr

Reads a unified diff and creates:

  • changed-file summary
  • risk estimate
  • review checklist
  • Codex review prompt

For UI/component diffs, it also adds a visual QA checklist for mobile/desktop checks, overflow/clipping, screenshots, and unrelated layout shifts.

cmtk visual

Turns a screenshot/layout bug report into a Codex-ready visual repair brief:

  • expected vs actual visual state
  • likely component/CSS/media inspection targets
  • screenshot QA checklist
  • browser verification steps
  • guardrails for keeping the fix scoped to UI/layout

cmtk release

Reads git log text and creates:

  • feature/fix/docs sections
  • other changes
  • pre-tag maintainer checklist

cmtk codex-task

Turns a maintainer request into a safer Codex task brief:

  • goal
  • context
  • step-by-step Codex instructions
  • definition of done
  • suggested Codex CLI command

Example output

# Codex task brief: CLI crashes when issue text is piped from stdin

## Goal
Prepare a safe implementation workflow...

## Instructions for Codex
1. Inspect the repository before changing files.
2. Identify the smallest set of files needed for the task.
3. If this is a bug, write or update a regression test first.
...

Project fit for Codex for Open Source

This project is intentionally aligned with maintainer workflows: issue triage, pull-request review, release workflows, and maintainer automation. It is small, local-first, and designed to prepare better work packets for Codex rather than hiding decisions behind opaque automation.

Suggested application summary, under 500 characters:

Codex Maintainer Kit is a small MIT-licensed CLI that helps open-source maintainers turn common repository inputs—issues, PR diffs, and git history—into structured, Codex-ready workflows. It focuses on practical maintainer tasks: issue triage, PR review briefs, release-note drafts, and bounded implementation prompts. The project is a good fit because it directly improves how maintainers prepare work for Codex while keeping humans in control of review, edits, and merge decisions.

More application copy and repository topics are in docs/github-application-copy.md.

Development

python -m pip install -e '.[dev]'
pytest -q
ruff check src tests

Roadmap

  • GitHub issue/PR URL ingestion through gh
  • Configurable templates
  • JSON schema output for automation
  • Optional OpenAI/Codex SDK integration
  • Release-note grouping by conventional commits
  • Deeper visual/layout bug workflows for screenshot-driven UI fixes

License

MIT

About

Turn issues, PR diffs, and git history into Codex-ready maintainer workflows.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages