AGENTS.md rule 8: a PR that changes a workflow, a guide or the README also updates the matching wiki pages and lists them in its description. The wiki is never pushed to by hand.
3.4 KiB
AGENTS.md
This project uses the SQA and QC framework mounted at framework/.
For any document under docs/ (create, edit or review) use the artifact
skill. For planning a project or a phase into tasks, and syncing phases and
tasks to Gitea/GitHub as Milestones and Issues, use the project-planning
skill. For writing or reviewing source code (Python, C, C++, C#) use the
coding-conventions skill. Skills are read from .agents/skills/ (this harness and Codex CLI)
and .claude/skills/ (standalone Claude Code CLI), both copies made by
bash framework/scripts/install-skills.sh — re-run it after updating the
framework.
Never commit, push or open a PR unless asked. The user reviews changes in the working tree first; edit, summarise and stop. The commit/PR rules below apply once a commit has been asked for.
Workflow order
Business Case, Stakeholder Analysis, Project Plan, milestones, tasks synced as
issues, then code. Nothing goes under src/ or tests/ unless a milestone
document (MIL-*) is accepted and the task is a row in it (ideally a synced
issue). If those are missing, plan with the project-planning skill, show the
dry-run output of bash framework/scripts/sync-project.sh, and stop. The rule
is defined once in framework/process/plan-first-gate.md.
A "build X" request is planning-first: produce the plan and issues, then ask
for a go-ahead. Only the user can waive the plan, in chat, for that request.
Before planning, find the Product Owner's language (the prompt, or the
Languages section of docs/artifact-registry.md); if neither states it, ask.
To enforce the gate at commit time, run
bash framework/scripts/install-git-hooks.sh --enable-plan-gate: a commit that
changes src/ or tests/ then needs a Task: MIL-NNN#N trailer.
Rules that apply to every document:
- Get the short name from
framework/registry/artifact-catalog.mdand the next version fromdocs/artifact-registry.md. Create files withbash framework/scripts/new-artifact.sh <SHORT>. - Owners, reviewers and RACI use stakeholder IDs from the project's Stakeholder Analysis, never invented role names.
- Every QC criterion is tagged with an ISO/IEC 25010:2023 characteristic.
- Every reviewed instance gets an
RC-*record indocs/sqa/reviews/. - Do not edit
framework/from this project; propose changes upstream. - Every PR description closes the issues its work completes, one
Closes #Nper line (Refs #Nfor partial work); see theproject-planningskill. - Every document's
## Version HistoryhasChangeandCommitcolumns and keeps the two latest rows. After committing, runframework/scripts/resolve-pending-commits.shand commit the result before opening the PR (no amend). Never ask for or perform the merge: a reviewer merges. - Keep the wiki current. A PR that changes a workflow under
.gitea/, a file inguides/orREADME.mdalso updates the matching pages inwiki/: runpython tools/build_wiki.pyfor the English pages (the tests fail when they are out of date) and update the Danish (da) and Bahasa Malaysia (ms) pages once they exist, naming the English source they follow. List the wiki pages the PR changed in its description, or say "No wiki pages changed: ". Never push to the wiki repository by hand: the publishing workflow (MIL-005 task 8) copieswiki/there when the PR is merged.