Skip to content

Commit 8cddc51

Browse files
committed
docs(ai-coders): add Section 4 pre-PR self-check
1 parent 0da8f9b commit 8cddc51

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

docs/develop_ai_coders.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,16 @@ Adding a new optimisation parameter requires 4 edits per `docs/develop.md`: (1)
9393

9494
### Source-resolve discipline
9595
Ambiguous types / signs / units / conventions: trace upstream code first. "Ask maintainer" is last resort. Real precedent: PR [#835](https://github.com/davidusb-geek/emhass/pull/835)'s sign-convention questions self-resolved from `optimization.py` MILP constraints rather than punting to the maintainer. Audit-source-ambiguity does not have to propagate into the PR.
96+
97+
## 4. Self-check pre-PR
98+
99+
Run through before opening:
100+
101+
- [ ] Issue filed if behavior change? (Per decision-tree in §2)
102+
- [ ] `pytest tests/` passes locally?
103+
- [ ] `uvx ruff check .` clean?
104+
- [ ] Sign conventions verified (if PR touches power / SOC / cost variables)?
105+
- [ ] One concern per PR (scope discipline)?
106+
- [ ] Issue or Discussion linked in PR body if applicable?
107+
- [ ] Reproducer in body if behavior-change fix?
108+
- [ ] Maintainer-scope-corridors checked? ([Discussion #808](https://github.com/davidusb-geek/emhass/discussions/808) Layers, [Discussion #789](https://github.com/davidusb-geek/emhass/discussions/789) MILP scope)

0 commit comments

Comments
 (0)