fix(agents): add mandatory PR compliance checklist to implementation-supervisor

Workers were systematically omitting CHANGELOG.md, CONTRIBUTORS.md, and
commit footer (ISSUES CLOSED: #N), causing all PRs to be blocked from merge.

Added a mandatory 8-item PR Compliance Checklist to the worker prompt body
in implementation-supervisor.md that supervisors must pass to every worker.
The checklist covers:
1. CHANGELOG.md update under [Unreleased]
2. CONTRIBUTORS.md update
3. Commit footer with ISSUES CLOSED: #N
4. CI verification (all quality gates green)
5. BDD/Behave test coverage
6. Epic reference in PR description
7. Labels applied via forgejo-label-manager
8. Milestone assignment

Also removed @tdd_expected_fail tag from PlanContextInheritance test in
depth_breadth_projection.feature (bug #4198 is fixed).

Added BDD tests in features/pr_compliance_checklist.feature with 10 scenarios
covering all 8 checklist items.

ISSUES CLOSED: #9824
This commit is contained in:
2026-05-04 22:37:19 +00:00
committed by HAL9000
parent e15f26a7bb
commit 63241f1859
6 changed files with 272 additions and 3 deletions
@@ -245,6 +245,16 @@ each work group's fetch algorithm:
The prompt body to pass to workers you spawn: The prompt body to pass to workers you spawn:
``` ```
Implement or fix the indicated issue or pull request. Implement or fix the indicated issue or pull request.
PR Compliance Checklist (MANDATORY — complete ALL items before creating a PR):
[ ] 1. CHANGELOG.md — add entry under [Unreleased] section
[ ] 2. CONTRIBUTORS.md — add or update contribution entry
[ ] 3. Commit footer — include `ISSUES CLOSED: #<issue-number>` in the commit message
[ ] 4. CI passes — all quality gates and tests green before requesting review
[ ] 5. BDD/Behave tests — added or updated for the changed behaviour
[ ] 6. Epic reference — PR description references the parent Epic issue number
[ ] 7. Labels — applied via forgejo-label-manager: State/In Review, Priority/<level>, MoSCoW/<level>, Type/<type>
[ ] 8. Milestone — PR assigned to the earliest open milestone matching the issue
``` ```
``` ```
+10
View File
@@ -24,6 +24,16 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
versions (<3.13.4) cannot be installed even if upstream transitive dependencies have loose versions (<3.13.4) cannot be installed even if upstream transitive dependencies have loose
version constraints. version constraints.
### Fixed
- **Implementation Supervisor PR Compliance Checklist** (#9824): Added a mandatory
8-item PR Compliance Checklist to the worker prompt body in `implementation-supervisor.md`
that every implementation worker must complete before creating a PR. Checklist covers:
CHANGELOG.md update, CONTRIBUTORS.md update, commit footer (`ISSUES CLOSED: #N`),
CI verification, BDD tests, Epic reference, label application via `forgejo-label-manager`,
and milestone assignment. This eliminates systemic PR merge blockers caused by workers
omitting required items.
### Changed ### Changed
- Restored `benchmark-regression` CI job to `master.yml` with `pull_request` trigger guard - Restored `benchmark-regression` CI job to `master.yml` with `pull_request` trigger guard
+2 -2
View File
@@ -7,7 +7,6 @@
* Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com> * Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com>
* Luis Mendes <luis.p.mendes@gmail.com> * Luis Mendes <luis.p.mendes@gmail.com>
* Rui Hu <rui.hu@cleverthis.com> * Rui Hu <rui.hu@cleverthis.com>
* HAL 9000 <hal9000@cleverthis.com>
# Details # Details
@@ -25,8 +24,9 @@ Below are some of the specific details of various contributions.
* This project was made possible thanks to considerable donation of time, money, and resources by CleverThis, Inc. * This project was made possible thanks to considerable donation of time, money, and resources by CleverThis, Inc.
* HAL 9000 has contributed automated bug fixes, CLI output formatting improvements, and ongoing maintenance as part of the CleverAgents automation system. * HAL 9000 has contributed automated bug fixes, CLI output formatting improvements, and ongoing maintenance as part of the CleverAgents automation system.
* HAL 9000 has contributed the file edit encoding parameter fix (PR #8258 / issue #7559). * HAL 9000 has contributed the file edit encoding parameter fix (PR #8258 / issue #7559).
* HAL 9000 has contributed the architecture-pool-supervisor milestone assignment feature (PR #8188 / issue #7521): added `forgejo_update_pull_request` permission and documented the PR workflow for major spec changes, enabling automatic milestone assignment for specification PRs. <<* HAL 9000 has contributed the architecture-pool-supervisor milestone assignment feature (PR #8188 / issue #7521): added `forgejo_update_pull_request` permission and documented the PR workflow for major spec changes, enabling automatic milestone assignment for specification PRs.
* HAL 9000 has contributed the git worktree TOCTOU race condition fix (PR #8178 / issue #7507): replaced the unsafe mkdtemp() + rmdir() pattern with a parent-directory approach to eliminate the race window in concurrent git worktree operations. * HAL 9000 has contributed the git worktree TOCTOU race condition fix (PR #8178 / issue #7507): replaced the unsafe mkdtemp() + rmdir() pattern with a parent-directory approach to eliminate the race window in concurrent git worktree operations.
* HAL 9000 has contributed the git_tools TOCTOU race condition fix (PR #8255 / issue #7619): eliminated the Time-Of-Check-To-Time-Of-Use race in `_get_base_env()` by adding double-checked locking with a module-level `threading.Lock`, preventing concurrent threads from writing conflicting environment snapshots. * HAL 9000 has contributed the git_tools TOCTOU race condition fix (PR #8255 / issue #7619): eliminated the Time-Of-Check-To-Time-Of-Use race in `_get_base_env()` by adding double-checked locking with a module-level `threading.Lock`, preventing concurrent threads from writing conflicting environment snapshots.
* HAL 9000 has contributed the mandatory PR compliance checklist to `implementation-supervisor.md` (#9824): added an 8-item checklist to the worker prompt body with concrete items covering CHANGELOG.md, CONTRIBUTORS.md, commit footer, CI verification, BDD tests, Epic reference, labels, and milestone assignment to eliminate systemic PR merge blockers.
* HAL 9000 has contributed comprehensive milestone documentation for v3.6.0 (Advanced Concepts & Deferred Features) and v3.7.0 (TUI Implementation) (PR #9903): split into sub-documents covering context strategies, LLM backends, resource types, A2A rename, container tool execution, scope chain resolution, cost/safety budgets, E2E workflow tests, code review examples, plugin architecture, TUI layout, persona system, reference/command input, session management, configuration, and TuiMaterializer integration. * HAL 9000 has contributed comprehensive milestone documentation for v3.6.0 (Advanced Concepts & Deferred Features) and v3.7.0 (TUI Implementation) (PR #9903): split into sub-documents covering context strategies, LLM backends, resource types, A2A rename, container tool execution, scope chain resolution, cost/safety budgets, E2E workflow tests, code review examples, plugin architecture, TUI layout, persona system, reference/command input, session management, configuration, and TuiMaterializer integration.
* HAL 9000 has contributed the LLMTraceRepository data-integrity fix (PR #8185 / issue #7505): replaced the unconditional `session.commit()` in `LLMTraceRepository.save()` with a dual-path implementation that respects the UnitOfWork pattern — flushing only when an external session is provided, and flushing + committing + closing when operating standalone. This eliminates premature transaction commits, loss of rollback capability, and a docstring/implementation mismatch. * HAL 9000 has contributed the LLMTraceRepository data-integrity fix (PR #8185 / issue #7505): replaced the unconditional `session.commit()` in `LLMTraceRepository.save()` with a dual-path implementation that respects the UnitOfWork pattern — flushing only when an external session is provided, and flushing + committing + closing when operating standalone. This eliminates premature transaction commits, loss of rollback capability, and a docstring/implementation mismatch.
+1 -1
View File
@@ -217,7 +217,7 @@ Feature: Depth/Breadth Projection System and Skeleton Context Propagation
And all child skeleton fragments should have detail depth at most 1 And all child skeleton fragments should have detail depth at most 1
And a child skeleton fragment should contain "[MODULE_GRAPH]: symbols=main" And a child skeleton fragment should contain "[MODULE_GRAPH]: symbols=main"
@inheritance @skeleton @tdd_issue @tdd_issue_4198 @tdd_expected_fail @inheritance @skeleton @tdd_issue @tdd_issue_4198
Scenario: PlanContextInheritance prioritises fragments near the child focus Scenario: PlanContextInheritance prioritises fragments near the child focus
Given the depth/breadth projection modules are available Given the depth/breadth projection modules are available
And a parent assembled context with the following inheritance fragments: And a parent assembled context with the following inheritance fragments:
+58
View File
@@ -0,0 +1,58 @@
@mock_only
Feature: PR Compliance Checklist in Implementation Supervisor
As an implementation supervisor
I want to pass a mandatory PR compliance checklist to every worker prompt
So that workers complete all required items before creating a PR and avoid systemic merge blockers
Background:
Given the implementation-supervisor.md agent definition exists
Scenario: Supervisor worker prompt includes the PR compliance checklist
When I read the implementation supervisor agent definition
Then the worker prompt body includes the PR compliance checklist section
And the checklist is marked as MANDATORY
Scenario: Checklist item 1 — CHANGELOG.md update required
When I read the implementation supervisor agent definition
Then the worker prompt body includes a CHANGELOG.md checklist item
And the item instructs workers to add an entry under the Unreleased section
Scenario: Checklist item 2 — CONTRIBUTORS.md update required
When I read the implementation supervisor agent definition
Then the worker prompt body includes a CONTRIBUTORS.md checklist item
And the item instructs workers to add or update their contribution entry
Scenario: Checklist item 3 — commit footer required
When I read the implementation supervisor agent definition
Then the worker prompt body includes a commit footer checklist item
And the item specifies the ISSUES CLOSED footer format
Scenario: Checklist item 4 — CI must pass before PR creation
When I read the implementation supervisor agent definition
Then the worker prompt body includes a CI passes checklist item
And the item instructs workers to verify all quality gates are green
Scenario: Checklist item 5 — BDD/Behave tests required
When I read the implementation supervisor agent definition
Then the worker prompt body includes a BDD tests checklist item
And the item instructs workers to add or update Behave feature files
Scenario: Checklist item 6 — Epic reference required in PR description
When I read the implementation supervisor agent definition
Then the worker prompt body includes an Epic reference checklist item
And the item instructs workers to reference the parent Epic issue number
Scenario: Checklist item 7 — Labels must be applied
When I read the implementation supervisor agent definition
Then the worker prompt body includes a labels checklist item
And the item instructs workers to apply labels via forgejo-label-manager
Scenario: Checklist item 8 — Milestone must be assigned
When I read the implementation supervisor agent definition
Then the worker prompt body includes a milestone checklist item
And the item instructs workers to assign the earliest open milestone
Scenario: All 8 checklist items are present in the worker prompt
When I read the implementation supervisor agent definition
Then the worker prompt body contains all 8 mandatory checklist items
@@ -0,0 +1,191 @@
"""Step definitions for PR compliance checklist in implementation supervisor."""
from pathlib import Path
from typing import Any
from behave import given, then, when
AGENT_DEF_PATH = (
Path(__file__).parent.parent.parent
/ ".opencode"
/ "agents"
/ "implementation-supervisor.md"
)
@given("the implementation-supervisor.md agent definition exists")
def step_agent_def_exists(context: Any) -> None:
"""Verify the implementation supervisor agent definition file exists."""
assert AGENT_DEF_PATH.exists(), (
f"Agent definition not found at {AGENT_DEF_PATH}"
)
context.agent_def_path = AGENT_DEF_PATH
@when("I read the implementation supervisor agent definition")
def step_read_agent_def(context: Any) -> None:
"""Read the implementation supervisor agent definition."""
context.agent_def_content = AGENT_DEF_PATH.read_text(encoding="utf-8")
@then("the worker prompt body includes the PR compliance checklist section")
def step_prompt_includes_checklist(context: Any) -> None:
"""Verify the worker prompt body includes the PR compliance checklist."""
assert "PR Compliance Checklist" in context.agent_def_content, (
"Worker prompt body does not include 'PR Compliance Checklist'"
)
@then("the checklist is marked as MANDATORY")
def step_checklist_is_mandatory(context: Any) -> None:
"""Verify the checklist is marked as MANDATORY."""
assert "MANDATORY" in context.agent_def_content, (
"PR Compliance Checklist is not marked as MANDATORY"
)
@then("the worker prompt body includes a CHANGELOG.md checklist item")
def step_prompt_includes_changelog_item(context: Any) -> None:
"""Verify the worker prompt body includes a CHANGELOG.md checklist item."""
assert "CHANGELOG.md" in context.agent_def_content, (
"Worker prompt body does not include a CHANGELOG.md checklist item"
)
@then("the item instructs workers to add an entry under the Unreleased section")
def step_changelog_item_unreleased(context: Any) -> None:
"""Verify the CHANGELOG.md item mentions the Unreleased section."""
assert "[Unreleased]" in context.agent_def_content, (
"CHANGELOG.md checklist item does not mention the [Unreleased] section"
)
@then("the worker prompt body includes a CONTRIBUTORS.md checklist item")
def step_prompt_includes_contributors_item(context: Any) -> None:
"""Verify the worker prompt body includes a CONTRIBUTORS.md checklist item."""
assert "CONTRIBUTORS.md" in context.agent_def_content, (
"Worker prompt body does not include a CONTRIBUTORS.md checklist item"
)
@then("the item instructs workers to add or update their contribution entry")
def step_contributors_item_add_update(context: Any) -> None:
"""Verify the CONTRIBUTORS.md item instructs workers to add or update."""
assert "add or update" in context.agent_def_content, (
"CONTRIBUTORS.md checklist item does not instruct workers to add or update"
)
@then("the worker prompt body includes a commit footer checklist item")
def step_prompt_includes_commit_footer_item(context: Any) -> None:
"""Verify the worker prompt body includes a commit footer checklist item."""
assert "Commit footer" in context.agent_def_content, (
"Worker prompt body does not include a commit footer checklist item"
)
@then("the item specifies the ISSUES CLOSED footer format")
def step_commit_footer_issues_closed(context: Any) -> None:
"""Verify the commit footer item specifies the ISSUES CLOSED format."""
assert "ISSUES CLOSED" in context.agent_def_content, (
"Commit footer checklist item does not specify the ISSUES CLOSED format"
)
@then("the worker prompt body includes a CI passes checklist item")
def step_prompt_includes_ci_item(context: Any) -> None:
"""Verify the worker prompt body includes a CI passes checklist item."""
assert "CI passes" in context.agent_def_content, (
"Worker prompt body does not include a CI passes checklist item"
)
@then("the item instructs workers to verify all quality gates are green")
def step_ci_item_quality_gates(context: Any) -> None:
"""Verify the CI item instructs workers to verify quality gates."""
assert "quality gates" in context.agent_def_content, (
"CI checklist item does not mention quality gates"
)
@then("the worker prompt body includes a BDD tests checklist item")
def step_prompt_includes_bdd_item(context: Any) -> None:
"""Verify the worker prompt body includes a BDD/Behave tests checklist item."""
assert "BDD/Behave tests" in context.agent_def_content, (
"Worker prompt body does not include a BDD/Behave tests checklist item"
)
@then("the item instructs workers to add or update Behave feature files")
def step_bdd_item_feature_files(context: Any) -> None:
"""Verify the BDD item instructs workers to add or update feature files."""
assert "added or updated" in context.agent_def_content, (
"BDD checklist item does not instruct workers to add or update feature files"
)
@then("the worker prompt body includes an Epic reference checklist item")
def step_prompt_includes_epic_item(context: Any) -> None:
"""Verify the worker prompt body includes an Epic reference checklist item."""
assert "Epic reference" in context.agent_def_content, (
"Worker prompt body does not include an Epic reference checklist item"
)
@then("the item instructs workers to reference the parent Epic issue number")
def step_epic_item_parent_reference(context: Any) -> None:
"""Verify the Epic item instructs workers to reference the parent Epic."""
assert "parent Epic" in context.agent_def_content, (
"Epic checklist item does not instruct workers to reference the parent Epic"
)
@then("the worker prompt body includes a labels checklist item")
def step_prompt_includes_labels_item(context: Any) -> None:
"""Verify the worker prompt body includes a labels checklist item."""
assert "Labels" in context.agent_def_content, (
"Worker prompt body does not include a labels checklist item"
)
@then("the item instructs workers to apply labels via forgejo-label-manager")
def step_labels_item_forgejo_label_manager(context: Any) -> None:
"""Verify the labels item instructs workers to use forgejo-label-manager."""
assert "forgejo-label-manager" in context.agent_def_content, (
"Labels checklist item does not mention forgejo-label-manager"
)
@then("the worker prompt body includes a milestone checklist item")
def step_prompt_includes_milestone_item(context: Any) -> None:
"""Verify the worker prompt body includes a milestone checklist item."""
assert "Milestone" in context.agent_def_content, (
"Worker prompt body does not include a milestone checklist item"
)
@then("the item instructs workers to assign the earliest open milestone")
def step_milestone_item_earliest(context: Any) -> None:
"""Verify the milestone item instructs workers to assign the earliest open milestone."""
assert "earliest open milestone" in context.agent_def_content, (
"Milestone checklist item does not mention the earliest open milestone"
)
@then("the worker prompt body contains all 8 mandatory checklist items")
def step_prompt_contains_all_8_items(context: Any) -> None:
"""Verify the worker prompt body contains all 8 mandatory checklist items."""
required_items = [
"CHANGELOG.md",
"CONTRIBUTORS.md",
"ISSUES CLOSED",
"CI passes",
"BDD/Behave tests",
"Epic reference",
"forgejo-label-manager",
"earliest open milestone",
]
missing = [item for item in required_items if item not in context.agent_def_content]
assert not missing, (
f"Worker prompt body is missing the following checklist items: {missing}"
)