Repository navigation
docs(governance): stop recommending forward declarations over header includes - #8339
Open
Critsium-xy wants to merge 1 commit into
Open
Critsium-xy wants to merge 1 commit into
Critsium-xy wants to merge 1 commit into
Conversation
ABACUS-PR-BOT
left a comment
Collaborator
There was a problem hiding this comment.
No implementation defect found in this wording change.
Static review of 12d4827665fd2a1d6d1bd4b77e9b8d0073ae3372: git diff --check passed; the checker and unit suite were not executed, and CI run results were not inspected.
| result = self.run_checker("--base", self.base, "--head", head) | ||
|
|
||
| self.assert_warns_with_success(result, "Header dependency review") | ||
| self.assertNotIn("forward declaration", result.stdout.lower()) |
Collaborator
There was a problem hiding this comment.
Non-blocking: The PR verification note relies on Agent Governance to run this test suite, but that workflow only invokes agent_governance_check.py. Please record a run of python3 -m unittest tools/03_code_analysis/test_agent_governance_check.py or add an explicit CI test step, and update the note.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reminder
AGENTS.mdanddocs/developers_guide/agent_governance.md.source/changes.Linked Issue
No separate issue: this is a governance documentation and checker message refinement requested during recent PR reviews (e.g. #8136, #8328).
Unit Tests and/or Case Tests for my changes
hasCR=False) on all 5 modified files and rangit diff --check(passed with no issues).tools/03_code_analysis/test_agent_governance_check.py::AgentGovernanceCheckTest::test_warns_for_new_header_includeto assert that theHeader dependency reviewwarning no longer suggests forward declarations.python3 -m unittest tools/03_code_analysis/test_agent_governance_check.pywas not run locally because this Windows environment does not have a local Python 3 interpreter configured; CI (Agent Governance) will run the test suite on this PR.What's changed?
Header dependency reviewwarning intools/03_code_analysis/agent_governance_check.py, but update its suggested action text so it no longer instructs contributors or AI agents to replace explicit#includedirectives with forward declarations.AGENTS.md,docs/developers_guide/agent_governance.md, and.github/instructions/abacus-governance.instructions.mdto remove guidance that encourages replacing explicit#includedependencies with forward declarations (which makes header dependencies implicit and harder to trace).tools/03_code_analysis/test_agent_governance_check.pyverifying the updated warning wording.Governance Notes
AGENTS.md,docs/developers_guide/agent_governance.md,.github/instructions/abacus-governance.instructions.md) and checker message text; no INPUT parameter or user-facing calculation behavior is changed.source/is untouched).