Fix Version/s: None
Component/s: Stack Documentation and UX
Sprint:Alert Production S17 - 3, Alert Production S17 - 4, Alert Production S17 - 5
Amend the Developer Guide to require that test modules be prefixed with test_ to enable automatic pytest discovery:
This change looks good to me. I have added Kian-Tat Lim as reviewer since it involves the style guide.
This looks fine.
I'd be tempted to introduce a new section to the Python Style Guide called "Unit Testing" that collects all guidelines specific to unit testing (see also
DM-7450). The Python Unit Testing page https://developer.lsst.io/coding/python_testing.html would continue as an informative guide.
I don't know if we want to implement that organization now, or if Kian-Tat Lim is fine with this implementation.
The text and changes look fine. When this is announced on Community, the recommended transition plan (presumably "as you go" with a check-off list, as mentioned in
RFC-229) should be publicized as well.
Collecting testing-relevant guidelines into a separate section may make sense but can be separate from this.
RFC-229 mentions a checklist for migrated packages. Is there something like that already?
Following discussion with Jonathan Sick, I've merged the developer guide changes. He will set up a check-off list and announce it on Community.
Confluence page linked from
RFC-229 and community.lsst.org. Thanks Jonathan Sick!
I don't think this ticket should be blocked by
DM-8467. I think we can change the naming guidelines any time. What's blocked is mass renaming of current test files whilst the pybind11 port is ongoing.