Skip to content

Commit 620feb6

Browse files
committed
Simplify PR template metadata requirements
1 parent 37e40ab commit 620feb6

3 files changed

Lines changed: 10 additions & 57 deletions

File tree

.github/pull_request_template.md

Lines changed: 6 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,15 @@
1-
### Reminder
2-
- [ ] I have read `AGENTS.md` and `docs/developers_guide/agent_governance.md`.
3-
- [ ] I have linked an issue or explained why this PR does not need one.
4-
- [ ] I have added adequate unit tests and/or case tests, or explained why not.
5-
- [ ] I have listed the exact verification commands run and their results.
6-
- [ ] 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 requested any needed governance exception below.
9-
101
### Linked Issue
11-
Fix #...
2+
Fix #
123

134
### Unit Tests and/or Case Tests for my changes
14-
- A unit test is added for each new feature or bug fix.
15-
16-
### Exact Verification Performed
175
- Commands run:
186
- Result summary:
197
- Checks not run, with reason:
208

219
### What's changed?
22-
- Example: My changes might affect the performance of the application under certain conditions, and I have tested the impact on various scenarios...
23-
24-
### Governance Checklist
25-
- Global dependencies: no net increase in `GlobalV`, `GlobalC`, or `PARAM` code references, or exception requested below with reason, scope, risk, and cleanup plan.
26-
- Default parameters: no new default arguments added to existing interfaces, or exception requested below.
27-
- Headers: no unnecessary header dependencies or `.hpp` propagation, or rationale provided below.
28-
- Line endings: text files use LF; only `.bat` and `.cmd` use CRLF.
29-
- Build linkage: new source files are listed in the relevant `CMakeLists.txt`, or rationale provided below.
30-
- Documentation: behavior/interface changes include documentation updates, or no documentation update is required because ...
31-
- CodeRabbit: if automatic review has not started and the repository has CodeRabbit installed, request `@coderabbitai review`.
32-
33-
### INPUT Parameter Changes
34-
- Parameters added/removed/changed:
35-
- `docs/parameters.yaml` updated: yes/no/not applicable
36-
- `docs/advanced/input_files/input-main.md` updated: yes/no/not applicable
37-
- If not updated, explain why no INPUT documentation update is required:
38-
39-
### Core Module Impact
40-
- Affected core modules:
41-
- Risk summary:
42-
- Compatibility or performance impact:
10+
- Example: brief summary of the user-visible or developer-facing change.
4311

44-
### Governance Exception
45-
- Rule:
46-
- Reason:
47-
- Scope:
48-
- User or maintenance risk:
49-
- Why the normal rule cannot be followed now:
50-
- Follow-up cleanup plan:
51-
- Requested approver:
12+
### Governance Notes
13+
- INPUT/docs changes:
14+
- Core module impact:
15+
- Exceptions requested:

tools/03_code_analysis/agent_governance_check.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -542,10 +542,6 @@ def check_pr_metadata(findings: List[Finding], body: Optional[str]) -> None:
542542
"Linked Issue",
543543
"Unit Tests and/or Case Tests for my changes",
544544
"What's changed?",
545-
"Governance Checklist",
546-
"INPUT Parameter Changes",
547-
"Core Module Impact",
548-
"Governance Exception",
549545
]
550546
sections = pr_sections(body)
551547
missing = [section for section in required_sections if section not in sections]
@@ -567,7 +563,7 @@ def check_pr_metadata(findings: List[Finding], body: Optional[str]) -> None:
567563
"pull_request.body",
568564
None,
569565
"; ".join(reason_parts),
570-
"Fill the PR template with issue linkage, test evidence, behavior impact, governance notes, and exception details.",
566+
"Fill the PR template with issue linkage, test evidence, and a concise change summary.",
571567
)
572568

573569

tools/03_code_analysis/test_agent_governance_check.py

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ def test_skips_pr_metadata_when_event_payload_is_not_a_pull_request(self):
322322
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
323323
self.assertNotIn("PR metadata completeness", result.stdout)
324324

325-
def test_accepts_filled_pr_template_fields_from_event_payload(self):
325+
def test_accepts_core_pr_template_fields_from_event_payload(self):
326326
event = self.repo / "event.json"
327327
event.write_text(
328328
json.dumps(
@@ -332,15 +332,7 @@ def test_accepts_filled_pr_template_fields_from_event_payload(self):
332332
"### Unit Tests and/or Case Tests for my changes\n"
333333
"Ran python3 -m unittest tools/03_code_analysis/test_agent_governance_check.py.\n\n"
334334
"### What's changed?\n"
335-
"Adds governance checks only; no runtime behavior change.\n\n"
336-
"### Governance Checklist\n"
337-
"Line endings, CMake linkage, and docs rules reviewed.\n\n"
338-
"### INPUT Parameter Changes\n"
339-
"No INPUT parameter changes.\n\n"
340-
"### Core Module Impact\n"
341-
"No core module impact.\n\n"
342-
"### Governance Exception\n"
343-
"No exceptions requested.\n"
335+
"Adds governance checks only; no runtime behavior change.\n"
344336
}
345337
}
346338
)
@@ -349,6 +341,7 @@ def test_accepts_filled_pr_template_fields_from_event_payload(self):
349341
result = self.run_checker("--event-path", str(event))
350342

351343
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
344+
self.assertNotIn("PR metadata completeness", result.stdout)
352345

353346
def test_warns_for_source_change_without_test_evidence(self):
354347
self.write("source/source_base/new_feature.cpp", "int new_feature() { return 1; }\n")

0 commit comments

Comments
 (0)