Skip to content

docs(governance): allow module-level AGENTS.md under source/ - #8148

Open
mohanchen wants to merge 3 commits into
deepmodeling:developfrom
mohanchen:2026-10-15-line1
Open

mohanchen wants to merge 3 commits into
deepmodeling:developfrom
mohanchen:2026-10-15-line1

Conversation

@mohanchen

Copy link
Copy Markdown
Collaborator

Root AGENTS.md, the governance document, and the Copilot/CodeRabbit review configuration now recognize an optional AGENTS.md inside each source/source_xxx/ module directory. Module-level files refine the root baseline and never override it.

Add source/source_esolver/AGENTS.md as the first such file: it states the esolver cockpit-dashboard constraint and two checkable rules -- orchestrate the algorithm flow only, and reuse the shared cross-solver naming.

.coderabbit.yaml loads nested AGENTS.md through a new "**/AGENTS.md" knowledge-base pattern.

Reminder

  • I have read AGENTS.md and docs/developers_guide/agent_governance.md.
  • I have linked an issue or explained why this PR does not need one.
  • I have added adequate unit tests and/or case tests, or explained why not.
  • I have listed the exact verification commands run and their results.
  • I have described user-visible behavior changes, including INPUT parameter changes.
  • I have explained core-module impact for ESolver, HSolver, ElecState, Hamilt, Operator, Psi, or other source/ changes.
  • I have requested any needed governance exception below.

Linked Issue

Fix #

Unit Tests and/or Case Tests for my changes

  • Commands run:
  • Result summary:
  • Checks not run, with reason:

What's changed?

  • Example: brief summary of the user-visible or developer-facing change.

Governance Notes

  • INPUT/docs changes:
  • Core module impact:
  • Exceptions requested:

Root AGENTS.md, the governance document, and the Copilot/CodeRabbit review
configuration now recognize an optional AGENTS.md inside each
source/source_xxx/ module directory. Module-level files refine the root
baseline and never override it.

Add source/source_esolver/AGENTS.md as the first such file: it states the
esolver cockpit-dashboard constraint and two checkable rules -- orchestrate
the algorithm flow only, and reuse the shared cross-solver naming.

.coderabbit.yaml loads nested AGENTS.md through a new "**/AGENTS.md"
knowledge-base pattern.
@mohanchen mohanchen added Machine Learning & AI Issues related to AI Standards Coding standards and governance rules and removed Machine Learning & AI Issues related to AI labels Oct 15, 2026
@mohanchen
mohanchen requested a review from Critsium-xy October 15, 2026 22:17
@mohanchen

Copy link
Copy Markdown
Collaborator Author

@ABACUS-PR-BOT please review the PR

@ABACUS-PR-BOT ABACUS-PR-BOT left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Static review of b7af2921: no blocking issues found in this docs/config-only change. git diff --check passed; the governance checker pinned at e9d04303 reported one metadata warning and no errors. No builds or runtime tests were run; CI status was unavailable through the required connector.

Non-blocking: Please fill the verification section with the static commands/results actually run and a docs/config-only reason for skipping runtime tests, add the issue or no-issue rationale, and replace the remaining template placeholders. The opening prose already describes the change.

Comment thread source/source_esolver/AGENTS.md Outdated
abacus_fixer and others added 2 commits October 17, 2026 19:52
Address the review note on PR deepmodeling#8148: the owning-module examples now use
the directory names registered in source/CMakeLists.txt (source_estate,
source_hamilt) instead of the legacy module_elecstate/module_hamilt names,
so the guidance is directly searchable.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@AsTonyshment AsTonyshment left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM.

Comment on lines +7 to +8
1. `esolver` functions only orchestrate the algorithm flow (e.g., SCF
iteration, relaxation steps). Any computation of a concrete physical

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should "relaxation steps" be listed as an ESolver responsibility here? The outer relaxation loop currently lives in Relax_Driver::relax_driver(), which calls ESolver's runner() through esolve() for each ionic step🤔

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Standards Coding standards and governance rules

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants