TXM Enrollment
Developer guide
Local repository setup and the required path from a ready task to a reviewed pull request.
Prerequisites
Install only the tools needed for the task. Project wrappers own tool versions where available.
| Tool | Requirement | Use |
|---|---|---|
| Git | Current supported release | Repository and branch operations |
| GitHub CLI | Authenticated organization access | Repository, issue, and Project access |
| Java | JDK 21 | Toolkit build and tests |
| Gradle | Checked-in wrapper | Do not substitute a global Gradle installation |
| Graph tooling | Python 3.12.14 and uv 0.12.9 | Installed by the Task 1 Graphify setup |
| MySQL | Community Server 8.4 LTS | Needed for later persistence tasks |
No container runtime is required. Local development does not use Docker, Docker Compose, or Testcontainers.
Repository setup
Run these commands in PowerShell from the directory where you keep source repositories.
Sign in to GitHub
gh auth login
Complete organization SSO authorization if GitHub requests it.
Clone the repository
gh repo clone maximus-txm/txm-enrollment
cd txm-enrollment
Synchronize develop
git switch develop
git pull --ff-only origin develop
git status --short --branch
Start fresh preparation from a clean working tree. Its generated reference and required graph changes may then remain uncommitted for immediate implementation.
Read the repository instructions
Read AGENTS.md before working. If Connection Point references are present, keep them under
cp-reference\. That directory is ignored, read-only, and never committed.
Task readiness
Backlog entries are Project drafts. Convert a draft to a repository issue before implementation so it has an issue number.
- Convert the Project draft to an issue in
txm-enrollment. - Assign the issue to the developer doing the work.
- Confirm dependency tasks are merged into
develop. - Confirm linked specifications and their transitive dependencies are
FROZEN. - Have the Lead authorize the assigned issue in the exact
Readystatus. - Run
/prepare-task {issue-number}for the repository issue. - Preparation produces one
PREPAREDconsolidated reference underspecs/implementation-docs/, with automatic completeness, integrity, and freshness checks. - Immediately run
/implement-task {issue-number}. No document approval, separate preparation review, documentation PR, or prior merge is required.
Do not start implementation from Backlog. /prepare-task requires an explicit numbered repository
issue and never changes Project status. /implement-task requires the assigned issue in Ready and its complete,
prepared, fresh reference. The reference may be untracked; it is carried into the task branch without committing it first.
Task workflow
One issue, one consolidated agent reference, one implementation session, one task branch, one independently reviewed implementation diff, and one implementation pull request.
-
/prepare-task
Prepare the agent reference
Run
/prepare-task {issue-number}. The agent consolidates the task's complete frozen source closure, constraints, inputs, and verification into one non-normative reference. It invents no requirements or decisions. Successful checks mark itPREPARED; no document approval or separate documentation PR is needed. It remains uncommitted, creates no new preparation branch, and never moves the implementation task status. -
/implement-task
Implement and verify
Run
/implement-task {issue-number}. The agent creates the task branch fromdevelop, validates the local prepared reference, carries it and required safe graph output unchanged onto the branch, moves the item to In progress, and implements the task. Every change remains uncommitted; unrelated dirty files are not carried. -
/review
Independent review
Run
/review {issue-number}. Review is read-only and checks the complete uncommitted diff against the prepared reference, independently checks the complete canonical source closure, and reviews correctness and unnecessary complexity. -
CHANGES_REQUIRED
Correct findings
Resume with
/implement-task {issue-number}on the same branch. Apply only the required corrections, rerun verification, and repeat/review. A reference defect returns to/prepare-task {issue-number}on the same task branch, preserving implementation files, then directly to implementation revalidation and fresh reviews. -
Manual review
Inspect the exact diff
After review returns PASS, the developer manually inspects the uncommitted changes. Any later change requires another independent and manual review.
-
/pr
Publish
Only
/prmay stage, commit, push, and open the pull request todevelop. It adds the required completion evidence and moves the Project item to In review. This one PR includes the exact implementation and prepared reference checked by independent review and the fresher. Nothing may change after that review.
Agents do not merge or mark work Done. Pull request acceptance and final Project status remain human-controlled.
Commands
Use repository wrappers and the smallest check that covers your change.
- Repository state
git status --short --branch- Full build
.\gradlew.bat --no-daemon --console=plain --stacktrace clean check build- Graph freshness
graph-check- Graph navigation
graph-query "<question>"- Graph update
graph-update— preparation for its reference change, implementation for code changes; never review or PR publication
The prepared reference contains the final verification commands for its task. Task 1 records the Gradle and Graphify wrappers as expected outputs; preparation must not require those files before that task creates them.
Troubleshooting
| Git returns SSO 403 | Authorize the active GitHub OAuth application for the organization, then retry the Git operation. |
|---|---|
| The task has no issue number | It is still a Project draft. Convert it to an issue in txm-enrollment. |
| No assigned Ready task | Confirm the issue is open, assigned to you, linked to EB-TXM, and in Ready. |
| The working tree is dirty | Preparation-only changes for the selected issue are allowed at implementation handoff. Unrelated changes, including workflow edits, must remain separate; never discard or overwrite them to start a task. |
| A specification is not frozen | Stop preparation and keep the item out of Ready. Use specification change control; implementation does not invent missing behavior. |
| The implementation document is invalid |
Run /prepare-task {issue-number}, then immediately /implement-task {issue-number} after
preparation passes. An INCOMPLETE reference or a manually changed status is not a successful preparation.
No document approval or documentation PR is required; source freshness and completeness still matter.
|
| Graph output is stale | Return to the owning preparation or implementation stage. Review, PR publication, hooks, and CI do not update tracked graph output. |