projmux: Instructions file for Codex

Agent Guide

Pull requests are accepted from maintainers only. Everyone else, please open an issue.

Commands

Run these in order for every change. ## Workflow explains the rules behind the order.

# start: confirm the checkout and its state
pwd
git status --short

# base check (on failure: rebase onto origin/main first)
git fetch origin main
git merge-base --is-ancestor origin/main HEAD

# Local checks
make fmt
make fix
make test

# publish: re-run the base check right before pushing
git fetch origin main
git merge-base --is-ancestor origin/main HEAD
git push -u origin <branch>            # after a rebase: git push --force-with-lease
gh pr create --title '<type>(<scope>): <summary>' --body-file <body.md>   # body: docs/pr-guideline.md

# CI checks on the same head: the five required checks (`Format`, `Unit Tests`, `NPM Packages`,
# `Integration Tests`, `E2E Tests`) and the aggregate `Test`. Integration and e2e are judged here, not run locally.
gh pr checks <num> --watch

# merge only when the Local checks passed and the CI checks are green on the same head
gh pr merge <num> --squash --delete-branch   # primary checkout; add --auto to queue it

# from a linked worktree, merge without --delete-branch (it checks out `main`, which another worktree holds)
# and delete the remote branch separately
gh pr merge <num> --squash
git push origin --delete <branch>

# after merge only (never before the merge and pull)
git pull --ff-only
make install

Scope

• projmux is a standalone tmux session-management application.
• Keep portable session-management behavior in projmux.
• Keep machine-local policy outside the application.
• This file is the shareable, tool-agnostic repo contract. Personal agent recipes, reverse-engineering notes, and machine-local operating memos belong in your own untracked notes, not this tracked file.
• Local-only agent overlays may live in an untracked AGENTS.local.md.

Repo map