fix(foreman): US English spelling + retire QA Enforcer from reference diagrams#80
Conversation
…agrams Co-authored-by: ewega <26189114+ewega@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates GitHub Foreman documentation to align with the current workflow (post–QA Enforcer removal) and standardize US English spelling in agent guidance.
Changes:
- Standardizes spelling in the Foreman agent doc (
behaviour→behavior). - Updates Foreman workflow reference diagrams to remove QA Enforcer and add CI as the automated gate.
- Renumbers and rewrites the sequence diagram phases to reflect the newer iterative review + CI gating loop.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/agents/references/foreman-workflows.md |
Updates Mermaid diagrams to reflect CI replacing QA Enforcer and the newer phase structure/tool naming. |
.github/agents/github-foreman.agent.md |
US English spelling consistency update in severity bucket description. |
Comments suppressed due to low confidence (1)
.github/agents/references/foreman-workflows.md:151
- The CI gate polling step in the sequence diagram uses
get_status (check runs), but the Foreman agent guidance specifies polling check runs viagithub/pull_request_readwithmethod: "get_checks". Updating this label to match the actual tool/method names will keep the reference diagram aligned with the current workflow docs.
Note over Foreman,CI: ═══ PHASE 4: CI GATE (automatic) ═══
CI->>PRs: go build / go vet / go test (Linux/Windows/macOS)
loop Poll every 2min until checks complete
Foreman->>PRs: get_status (check runs)
alt All green
| %% Foreman triggers code review | ||
| F -->|"MCP: request_copilot_review"| CRA | ||
| F -->|"github/request_copilot_review"| CRA | ||
| CRA -->|"review comments"| PR1 | ||
| CRA -->|"review comments"| PR2 | ||
| CRA -.->|"reads review guidance"| CI | ||
| CRA -.->|"reads review guidance"| INST |
There was a problem hiding this comment.
In the interaction graph, tool labels are partially migrated to the github/* style (e.g., github/request_copilot_review), but the earlier edges still use the old MCP: prefix for list_issues/issue_read and assign_copilot_to_issue. This leaves the diagram inconsistent and contradicts the PR description’s claim that tool labels were updated where applicable; consider updating those remaining edge labels to github/list_issues, github/issue_read, and github/assign_copilot_to_issue for consistency.
This issue also appears on line 147 of the same file.
There was a problem hiding this comment.
Fixed in commit 62361a0 — updated the remaining MCP: edge labels to github/list_issues, github/issue_read, and github/assign_copilot_to_issue for consistency with the rest of the diagram.
|
@copilot apply changes based on the comments in this thread |
Co-authored-by: ewega <26189114+ewega@users.noreply.github.com>
| Note over Foreman,CI: ═══ PHASE 4: CI GATE (automatic) ═══ | ||
| CI->>PRs: go build / go vet / go test (Linux/Windows/macOS) | ||
| loop Poll every 2min until checks complete | ||
| Foreman->>PRs: get_status (check runs) |
There was a problem hiding this comment.
In the sequence diagram’s CI gate, Foreman->>PRs: get_status (check runs) doesn’t match the actual Phase 4 guidance in github-foreman.agent.md, which uses github/pull_request_read with method: "get_checks". Update the diagram step to use the same method name (and ideally mention github/pull_request_read) so the reference diagrams stay consistent with the authoritative workflow doc.
| Foreman->>PRs: get_status (check runs) | |
| Foreman->>PRs: github/pull_request_read (method: "get_checks") |
There was a problem hiding this comment.
Fixed in commit 85dc1bc — updated to github/pull_request_read (method: "get_checks").
| PR1["PR #1<br/>copilot/issue-X"] | ||
| PR2["PR #2<br/>copilot/issue-Y"] | ||
| CI["copilot-instructions.md"] | ||
| INST["copilot-instructions.md"] |
There was a problem hiding this comment.
The interaction graph node label INST["copilot-instructions.md"] is a bit misleading since the file in this repo is .github/copilot-instructions.md (and other agent docs reference the full path). Consider updating the node label to .github/copilot-instructions.md for accuracy.
| INST["copilot-instructions.md"] | |
| INST[".github/copilot-instructions.md"] |
There was a problem hiding this comment.
Fixed in commit 85dc1bc — node label updated to .github/copilot-instructions.md.
|
@copilot apply changes based on the comments in this thread |
…step Co-authored-by: ewega <26189114+ewega@users.noreply.github.com>
* refactor(foreman): iterative review loop, CI gate, phase renumber * fix(foreman): remove Explore agent (no file backing), update mcp_github_ refs in phases 1/1b/2/2b * fix(foreman): US English spelling + retire QA Enforcer from reference diagrams (#80) * Initial plan * fix(foreman): behavior spelling, remove QA Enforcer from reference diagrams Co-authored-by: ewega <26189114+ewega@users.noreply.github.com> * fix(foreman): update remaining MCP: edge labels to github/* style Co-authored-by: ewega <26189114+ewega@users.noreply.github.com> * fix(foreman): accurate node label + github/pull_request_read CI gate step Co-authored-by: ewega <26189114+ewega@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ewega <26189114+ewega@users.noreply.github.com> * Update .github/agents/github-foreman.agent.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update .github/agents/github-foreman.agent.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix interaction diagram to reflect ruleset-driven code review trigger (#81) * Initial plan * Update interaction diagram to reflect ruleset-driven code review trigger Co-authored-by: ewega <26189114+ewega@users.noreply.github.com> * Update .github/agents/references/foreman-workflows.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ewega <26189114+ewega@users.noreply.github.com> Co-authored-by: Eldrick Wega <ewega@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
MCP:edge labels togithub/*style in interaction graph.github/copilot-instructions.md(accurate path)github/pull_request_read (method: "get_checks")💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.