Skip to content

Commit c7d3412

Browse files
committed
Precommit: Prettify all Markdown files
1 parent 75debc2 commit c7d3412

98 files changed

Lines changed: 5701 additions & 3433 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.ci/slurm/README.md‎

Lines changed: 102 additions & 37 deletions
Large diffs are not rendered by default.

‎.github/copilot-instructions.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# ABACUS Copilot Instructions
22

3-
Before generating code or reviewing pull requests in this repository, follow
4-
the ABACUS development baseline in:
3+
Before generating code or reviewing pull requests in this repository, follow the ABACUS development
4+
baseline in:
55

66
- `AGENTS.md`
77
- `docs/developers_guide/agent_governance.md`
88

9-
Treat `AGENTS.md` as the short entry point and
10-
`docs/developers_guide/agent_governance.md` as the complete rule source. Review
11-
the pull request diff before general style feedback, and separate blocking
12-
diff-scoped issues from historical or advisory observations.
9+
Treat `AGENTS.md` as the short entry point and `docs/developers_guide/agent_governance.md` as the
10+
complete rule source. Review the pull request diff before general style feedback, and separate
11+
blocking diff-scoped issues from historical or advisory observations.
1312

1413
Use the ABACUS review finding format for actionable findings:
1514

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,34 @@
1-
---
2-
applyTo: "**"
3-
---
1+
______________________________________________________________________
2+
3+
## applyTo: "\*\*"
44

55
# ABACUS Governance Review Instructions
66

77
Apply these instructions when reviewing or changing ABACUS code:
88

9-
- Use `AGENTS.md` and `docs/developers_guide/agent_governance.md` as the
10-
authoritative project baseline.
11-
- Keep review scope diff-oriented: new files, diff-added lines, new includes,
12-
newly introduced symbols, and changed text files for line-ending checks.
13-
- Do not treat untouched historical debt as a default blocker. Mention it only
14-
when it affects the changed area, and label it as advisory.
15-
- Flag PRs that increase `GlobalV`, `GlobalC`, or `PARAM` code references as
16-
blocker-level governance issues. Flag migration-neutral added usage as a
17-
warning that requires reason, scope, risk, and cleanup/follow-up rationale.
18-
Prefer explicit dependencies or narrow local interfaces.
19-
- Flag new default arguments in existing header interfaces. Prefer explicit
20-
call-site updates, overloads, or a clearer configuration object.
21-
- Review header include growth and `.hpp` propagation carefully. These are
22-
usually warnings unless the PR records a narrow reason.
23-
- Require LF line endings for text files. `.bat` and `.cmd` files are the CRLF
24-
exceptions.
25-
- Flag new `#pragma once` in header files as a blocker-level governance issue.
26-
Require traditional `#ifndef`/`#define`/`#endif` include guards instead.
27-
- For INPUT parameter behavior changes, require corresponding C++ `Input_Item`
28-
metadata updates, or a clear no-update explanation in the PR. Do not require
29-
generated YAML or Markdown documentation files to be committed.
30-
- Check that new source files are linked through the relevant `CMakeLists.txt`
31-
unless the PR explains generated or indirect inclusion.
9+
- Use `AGENTS.md` and `docs/developers_guide/agent_governance.md` as the authoritative project
10+
baseline.
11+
- Keep review scope diff-oriented: new files, diff-added lines, new includes, newly introduced
12+
symbols, and changed text files for line-ending checks.
13+
- Do not treat untouched historical debt as a default blocker. Mention it only when it affects the
14+
changed area, and label it as advisory.
15+
- Flag PRs that increase `GlobalV`, `GlobalC`, or `PARAM` code references as blocker-level
16+
governance issues. Flag migration-neutral added usage as a warning that requires reason, scope,
17+
risk, and cleanup/follow-up rationale. Prefer explicit dependencies or narrow local interfaces.
18+
- Flag new default arguments in existing header interfaces. Prefer explicit call-site updates,
19+
overloads, or a clearer configuration object.
20+
- Review header include growth and `.hpp` propagation carefully. These are usually warnings unless
21+
the PR records a narrow reason.
22+
- Require LF line endings for text files. `.bat` and `.cmd` files are the CRLF exceptions.
23+
- Flag new `#pragma once` in header files as a blocker-level governance issue. Require traditional
24+
`#ifndef`/`#define`/`#endif` include guards instead.
25+
- For INPUT parameter behavior changes, require corresponding C++ `Input_Item` metadata updates, or
26+
a clear no-update explanation in the PR. Do not require generated YAML or Markdown documentation
27+
files to be committed.
28+
- Check that new source files are linked through the relevant `CMakeLists.txt` unless the PR
29+
explains generated or indirect inclusion.
3230
- Keep default C++ changes compatible with the repository C++11 baseline.
33-
- Ask for focused tests or explicit test rationale for feature changes, bug
34-
fixes, INPUT behavior changes, heterogeneous kernels, and core-module
35-
refactors.
36-
- Treat CI governance findings as deterministic evidence and semantic review
37-
findings as advisory until maintainers approve them.
31+
- Ask for focused tests or explicit test rationale for feature changes, bug fixes, INPUT behavior
32+
changes, heterogeneous kernels, and core-module refactors.
33+
- Treat CI governance findings as deterministic evidence and semantic review findings as advisory
34+
until maintainers approve them.

‎.github/pull_request_template.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
11
### Reminder
2+
23
- [ ] I have read `AGENTS.md` and `docs/developers_guide/agent_governance.md`.
34
- [ ] I have linked an issue or explained why this PR does not need one.
45
- [ ] I have added adequate unit tests and/or case tests, or explained why not.
56
- [ ] I have listed the exact verification commands run and their results.
67
- [ ] I have described user-visible behavior changes, including INPUT parameter changes.
7-
- [ ] I have explained core-module impact for ESolver, HSolver, ElecState, Hamilt, Operator, Psi, or other `source/` changes.
8+
- [ ] I have explained core-module impact for ESolver, HSolver, ElecState, Hamilt, Operator, Psi, or
9+
other `source/` changes.
810
- [ ] I have requested any needed governance exception below.
911

1012
### Linked Issue
13+
1114
Fix #
1215

1316
### Unit Tests and/or Case Tests for my changes
17+
1418
- Commands run:
1519
- Result summary:
1620
- Checks not run, with reason:
1721

1822
### What's changed?
23+
1924
- Example: brief summary of the user-visible or developer-facing change.
2025

2126
### Governance Notes
27+
2228
- INPUT/docs changes:
2329
- Core module impact:
2430
- Exceptions requested:

‎.pre-commit-config.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ repos:
1515
hooks:
1616
- id: cmake-format
1717
additional_dependencies: [pyyaml]
18+
- repo: https://github.com/executablebooks/mdformat
19+
rev: 1.0.0
20+
hooks:
21+
- id: mdformat
22+
args: [--wrap, "100"]
23+
additional_dependencies:
24+
- mdformat-gfm
1825
- repo: local
1926
hooks:
2027
- id: abacus-agent-governance

0 commit comments

Comments
 (0)