Repository navigation
Precommit: Format all Markdown files #8201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,34 @@ | ||
| --- | ||
| applyTo: "**" | ||
| --- | ||
| ______________________________________________________________________ | ||
|
|
||
| ## applyTo: "\*\*" | ||
|
|
||
| # ABACUS Governance Review Instructions | ||
|
|
||
| Apply these instructions when reviewing or changing ABACUS code: | ||
|
|
||
| - Use `AGENTS.md` and `docs/developers_guide/agent_governance.md` as the | ||
| authoritative project baseline. | ||
| - Keep review scope diff-oriented: new files, diff-added lines, new includes, | ||
| newly introduced symbols, and changed text files for line-ending checks. | ||
| - Do not treat untouched historical debt as a default blocker. Mention it only | ||
| when it affects the changed area, and label it as advisory. | ||
| - Flag PRs that increase `GlobalV`, `GlobalC`, or `PARAM` code references as | ||
| blocker-level governance issues. Flag migration-neutral added usage as a | ||
| warning that requires reason, scope, risk, and cleanup/follow-up rationale. | ||
| Prefer explicit dependencies or narrow local interfaces. | ||
| - Flag new default arguments in existing header interfaces. Prefer explicit | ||
| call-site updates, overloads, or a clearer configuration object. | ||
| - Review header include growth and `.hpp` propagation carefully. These are | ||
| usually warnings unless the PR records a narrow reason. | ||
| - Require LF line endings for text files. `.bat` and `.cmd` files are the CRLF | ||
| exceptions. | ||
| - Flag new `#pragma once` in header files as a blocker-level governance issue. | ||
| Require traditional `#ifndef`/`#define`/`#endif` include guards instead. | ||
| - For INPUT parameter behavior changes, require corresponding C++ `Input_Item` | ||
| metadata updates, or a clear no-update explanation in the PR. Do not require | ||
| generated YAML or Markdown documentation files to be committed. | ||
| - Check that new source files are linked through the relevant `CMakeLists.txt` | ||
| unless the PR explains generated or indirect inclusion. | ||
| - Use `AGENTS.md` and `docs/developers_guide/agent_governance.md` as the authoritative project | ||
| baseline. | ||
| - Keep review scope diff-oriented: new files, diff-added lines, new includes, newly introduced | ||
| symbols, and changed text files for line-ending checks. | ||
| - Do not treat untouched historical debt as a default blocker. Mention it only when it affects the | ||
| changed area, and label it as advisory. | ||
| - Flag PRs that increase `GlobalV`, `GlobalC`, or `PARAM` code references as blocker-level | ||
| governance issues. Flag migration-neutral added usage as a warning that requires reason, scope, | ||
| risk, and cleanup/follow-up rationale. Prefer explicit dependencies or narrow local interfaces. | ||
| - Flag new default arguments in existing header interfaces. Prefer explicit call-site updates, | ||
| overloads, or a clearer configuration object. | ||
| - Review header include growth and `.hpp` propagation carefully. These are usually warnings unless | ||
| the PR records a narrow reason. | ||
| - Require LF line endings for text files. `.bat` and `.cmd` files are the CRLF exceptions. | ||
| - Flag new `#pragma once` in header files as a blocker-level governance issue. Require traditional | ||
| `#ifndef`/`#define`/`#endif` include guards instead. | ||
| - For INPUT parameter behavior changes, require corresponding C++ `Input_Item` metadata updates, or | ||
| a clear no-update explanation in the PR. Do not require generated YAML or Markdown documentation | ||
| files to be committed. | ||
| - Check that new source files are linked through the relevant `CMakeLists.txt` unless the PR | ||
| explains generated or indirect inclusion. | ||
| - Keep default C++ changes compatible with the repository C++11 baseline. | ||
| - Ask for focused tests or explicit test rationale for feature changes, bug | ||
| fixes, INPUT behavior changes, heterogeneous kernels, and core-module | ||
| refactors. | ||
| - Treat CI governance findings as deterministic evidence and semantic review | ||
| findings as advisory until maintainers approve them. | ||
| - Ask for focused tests or explicit test rationale for feature changes, bug fixes, INPUT behavior | ||
| changes, heterogeneous kernels, and core-module refactors. | ||
| - Treat CI governance findings as deterministic evidence and semantic review findings as advisory | ||
| until maintainers approve them. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,30 @@ | ||
| ### 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 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: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,13 @@ repos: | |
| hooks: | ||
| - id: cmake-format | ||
| additional_dependencies: [pyyaml] | ||
| - repo: https://github.com/executablebooks/mdformat | ||
| rev: 1.0.0 | ||
| hooks: | ||
| - id: mdformat | ||
| args: [--wrap, "100"] | ||
| additional_dependencies: | ||
| - mdformat-gfm | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The formatting changes TeX itself: for example, |
||
| - repo: local | ||
| hooks: | ||
| - id: abacus-agent-governance | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This changes the YAML
applyTo: "**"frontmatter into a thematic break and a heading. Copilot reads that glob from frontmatter to select path-specific instructions, so the heading no longer supplies the all-files selector. Please restore the frontmatter and preserve it during formatting, or exclude this instruction file from unsupported formatting.